From 3a0ac8525e2fb53d65aa3c4a7067ba1658a56201 Mon Sep 17 00:00:00 2001 From: Octobob Date: Mon, 7 Sep 2026 15:15:27 +0000 Subject: [PATCH] Sync generated API docs origin revision: 599b775e --- src/pages/docs/api/_generated/accounts.md | 43 +-- .../docs/api/_generated/action-templates.md | 55 ++-- src/pages/docs/api/_generated/api-keys.md | 52 ++-- src/pages/docs/api/_generated/artifacts.md | 35 +-- src/pages/docs/api/_generated/audit-stream.md | 10 +- .../docs/api/_generated/authentication.md | 10 +- src/pages/docs/api/_generated/branches.md | 64 ++-- .../docs/api/_generated/build-information.md | 31 +- src/pages/docs/api/_generated/certificates.md | 125 +++----- src/pages/docs/api/_generated/channels.md | 116 +++----- .../_generated/community-action-templates.md | 33 +-- .../api/_generated/compliance-policies.md | 15 +- .../docs/api/_generated/configuration.md | 27 +- .../api/_generated/dashboard-configuration.md | 10 +- src/pages/docs/api/_generated/dashboard.md | 50 +--- .../docs/api/_generated/deployment-freeze.md | 10 +- .../api/_generated/deployment-processes.md | 71 ++--- .../api/_generated/deployment-settings.md | 22 +- .../docs/api/_generated/deployment-targets.md | 172 +++++------ src/pages/docs/api/_generated/deployments.md | 43 +-- src/pages/docs/api/_generated/environments.md | 165 ++++++----- .../docs/api/_generated/event-retention.md | 44 ++- src/pages/docs/api/_generated/events.md | 276 ++++++++++++++---- .../api/_generated/features-configuration.md | 17 +- src/pages/docs/api/_generated/feeds.md | 79 ++--- src/pages/docs/api/_generated/git-hub.md | 28 +- src/pages/docs/api/_generated/home.md | 10 +- src/pages/docs/api/_generated/insights.md | 47 +-- .../docs/api/_generated/interruptions.md | 35 +-- src/pages/docs/api/_generated/invitations.md | 10 +- src/pages/docs/api/_generated/lets-encrypt.md | 18 +- .../api/_generated/library-variable-sets.md | 51 ++-- src/pages/docs/api/_generated/licenses.md | 18 +- src/pages/docs/api/_generated/lifecycles.md | 51 ++-- .../docs/api/_generated/machine-policies.md | 93 +++--- src/pages/docs/api/_generated/machines.md | 8 +- .../_generated/maintenance-configuration.md | 14 +- src/pages/docs/api/_generated/migrations.md | 10 +- src/pages/docs/api/_generated/nuget.md | 10 +- .../api/_generated/octopus-server-nodes.md | 47 +-- src/pages/docs/api/_generated/packages.md | 63 ++-- src/pages/docs/api/_generated/performance.md | 10 +- src/pages/docs/api/_generated/platform-hub.md | 163 +++++------ src/pages/docs/api/_generated/progression.md | 59 ++-- .../docs/api/_generated/project-groups.md | 60 ++-- .../docs/api/_generated/project-triggers.md | 164 ++++------- src/pages/docs/api/_generated/projects.md | 51 ++-- src/pages/docs/api/_generated/proxies.md | 39 +-- .../docs/api/_generated/rate-limiting.md | 30 +- src/pages/docs/api/_generated/releases.md | 186 +++++------- src/pages/docs/api/_generated/retention.md | 6 +- .../docs/api/_generated/runbook-processes.md | 88 ++---- src/pages/docs/api/_generated/runbook-runs.md | 68 ++--- .../docs/api/_generated/runbook-snapshots.md | 196 +++++-------- src/pages/docs/api/_generated/runbooks.md | 205 +++++-------- .../docs/api/_generated/scheduled-jobs.md | 14 +- .../docs/api/_generated/scoped-user-roles.md | 35 +-- .../docs/api/_generated/server-status.md | 18 +- src/pages/docs/api/_generated/server.md | 10 +- src/pages/docs/api/_generated/signing.md | 10 +- src/pages/docs/api/_generated/smtp.md | 22 +- src/pages/docs/api/_generated/spaces.md | 114 +++----- .../docs/api/_generated/subscriptions.md | 39 +-- src/pages/docs/api/_generated/tag-sets.md | 41 +-- src/pages/docs/api/_generated/tasks.md | 76 ++--- src/pages/docs/api/_generated/teams.md | 60 ++-- src/pages/docs/api/_generated/telemetry.md | 18 +- src/pages/docs/api/_generated/tenants.md | 63 ++-- src/pages/docs/api/_generated/upgrade.md | 10 +- .../docs/api/_generated/user-permissions.md | 10 +- src/pages/docs/api/_generated/user-roles.md | 39 +-- src/pages/docs/api/_generated/users.md | 51 ++-- src/pages/docs/api/_generated/variables.md | 30 +- src/pages/docs/api/_generated/worker-pools.md | 68 ++--- .../docs/api/_generated/worker-task-leases.md | 19 +- src/pages/docs/api/_generated/workers.md | 96 +++--- 76 files changed, 1719 insertions(+), 2537 deletions(-) diff --git a/src/pages/docs/api/_generated/accounts.md b/src/pages/docs/api/_generated/accounts.md index 9a3ed44c78..8f167a67d0 100644 --- a/src/pages/docs/api/_generated/accounts.md +++ b/src/pages/docs/api/_generated/accounts.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Accounts --- @@ -36,7 +36,8 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AccountType`** :span[enum]{.type-label} Allowed values: `AmazonWebServicesAccount`, `AmazonWebServicesOidcAccount`, `AzureOidc`, `AzureServicePrincipal`, `AzureSubscription`, `GenericOidcAccount`, `GoogleCloudAccount`, `GoogleCloudOidcAccount`, `None`, `SshKeyPair`, `Token`, `UsernamePassword`. @@ -72,7 +73,7 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Account", "Items": [ { "AccountType": "AmazonWebServicesAccount", @@ -85,9 +86,7 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -102,17 +101,15 @@ Lists accounts in the supplied Octopus Deploy Space in pages. The results will b "TenantedDeploymentParticipation": "Untenanted" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -204,9 +201,7 @@ Also reachable at `/api/accounts`, `/api/spaces/{spaceIdentifier}/accounts`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -274,9 +269,7 @@ Lists all of the accounts in the supplied Octopus Deploy Space. The results will "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -394,9 +387,7 @@ Also reachable at `/api/accounts/{accountId}`, `/api/spaces/{spaceIdentifier}/ac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -463,9 +454,7 @@ Also reachable at `/api/accounts/{id}`, `/api/spaces/{spaceIdentifier}/accounts/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -655,9 +644,7 @@ Also reachable at `/api/accounts/{id}/usages`, `/api/spaces/{spaceIdentifier}/ac } ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectTenantVariables": [ { diff --git a/src/pages/docs/api/_generated/action-templates.md b/src/pages/docs/api/_generated/action-templates.md index 7e44d9d4d3..1439786696 100644 --- a/src/pages/docs/api/_generated/action-templates.md +++ b/src/pages/docs/api/_generated/action-templates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Action Templates --- @@ -77,7 +77,8 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ActionType`** :span[string]{.type-label} Minimum length 1. @@ -114,7 +115,7 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ActionTemplate", "Items": [ { "ActionType": "string", @@ -127,9 +128,7 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -147,17 +146,15 @@ Lists all of the Action Templates in the supplied Octopus Deploy Space. The resu "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -404,9 +401,7 @@ Also reachable at `/api/actiontemplates`, `/api/spaces/{spaceIdentifier}/actiont "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -572,9 +567,7 @@ Lists the all of the action templates in the supplied Octopus Deploy Space. The "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -828,9 +821,7 @@ Also reachable at `/api/actiontemplates/{id}`, `/api/spaces/{spaceIdentifier}/ac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -1136,9 +1127,7 @@ Also reachable at `/api/actiontemplates/{id}`, `/api/spaces/{spaceIdentifier}/ac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -1745,9 +1734,7 @@ Gets a list of all steps/deployment processes that use a given action template. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProcessId": "string", "ProcessType": "Deployment", @@ -1829,9 +1816,7 @@ Also reachable at `/api/actiontemplates/{id}/v1`, `/api/spaces/{spaceIdentifier} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -1974,9 +1959,7 @@ Also reachable at `/api/actiontemplates/{id}/versions`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -2120,9 +2103,7 @@ Also reachable at `/api/actiontemplates/{id}/versions/{version}`, `/api/spaces/{ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ diff --git a/src/pages/docs/api/_generated/api-keys.md b/src/pages/docs/api/_generated/api-keys.md index 66037704ac..8033d20471 100644 --- a/src/pages/docs/api/_generated/api-keys.md +++ b/src/pages/docs/api/_generated/api-keys.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Api Keys --- @@ -33,7 +33,8 @@ Lists all API keys for a user, returning the most recent results first. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AccessLevel`** :span[enum]{.type-label} The access level this API key grants. @@ -75,7 +76,7 @@ Lists all API keys for a user, returning the most recent results first. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ApiKey", "Items": [ { "AccessLevel": "FullAccess", @@ -93,25 +94,21 @@ Lists all API keys for a user, returning the most recent results first. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUsedTimeStamp": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Purpose": "string", "UserId": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -190,9 +187,7 @@ The API Key returned in the result must be saved by the caller, as it cannot be "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUsedTimeStamp": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Purpose": "string", "UserId": "string" @@ -229,7 +224,8 @@ Lists all API keys for a user, returning the most recent results first. - **`ApiKeys`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -247,7 +243,7 @@ Lists all API keys for a user, returning the most recent results first. { "ApiKeys": { "Id": "string", - "ItemType": "string", + "ItemType": "ApiKey", "Items": [ { "AccessLevel": "FullAccess", @@ -260,22 +256,22 @@ Lists all API keys for a user, returning the most recent results first. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUsedTimeStamp": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Purpose": "string", "UserId": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` @@ -343,9 +339,7 @@ Lists all API keys for a user, returning the most recent results first. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUsedTimeStamp": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Purpose": "string", "UserId": "string" diff --git a/src/pages/docs/api/_generated/artifacts.md b/src/pages/docs/api/_generated/artifacts.md index 8b284a70e3..346deba2d4 100644 --- a/src/pages/docs/api/_generated/artifacts.md +++ b/src/pages/docs/api/_generated/artifacts.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Artifacts --- @@ -39,7 +39,8 @@ Lists all of the artifacts in the supplied Octopus Deploy Space, from all releas - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Created`** :span[string]{.type-label} Gets or sets the time at which the artifact was created. Format `date-time`. @@ -75,7 +76,7 @@ Lists all of the artifacts in the supplied Octopus Deploy Space, from all releas ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Artifact", "Items": [ { "Created": "2020-01-01T00:00:00.000Z", @@ -84,9 +85,7 @@ Lists all of the artifacts in the supplied Octopus Deploy Space, from all releas "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67", "ServerTaskId": "string", @@ -94,17 +93,15 @@ Lists all of the artifacts in the supplied Octopus Deploy Space, from all releas "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -180,9 +177,7 @@ Creates a new artifact. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67", "ServerTaskId": "string", @@ -238,9 +233,7 @@ Also reachable at `/api/artifacts/{id}`, `/api/spaces/{spaceIdentifier}/artifact "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67", "ServerTaskId": "string", @@ -296,9 +289,7 @@ Also reachable at `/api/artifacts/{id}`, `/api/spaces/{spaceIdentifier}/artifact "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "LogCorrelationId": "0c5a872485ac4b10857939a92d082e67", "ServerTaskId": "string", diff --git a/src/pages/docs/api/_generated/audit-stream.md b/src/pages/docs/api/_generated/audit-stream.md index c67c54141c..a179788434 100644 --- a/src/pages/docs/api/_generated/audit-stream.md +++ b/src/pages/docs/api/_generated/audit-stream.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Audit Stream --- @@ -34,9 +34,7 @@ title: Audit Stream "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StreamConfigurationResource": {} } @@ -88,9 +86,7 @@ title: Audit Stream "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StreamConfigurationResource": {} } diff --git a/src/pages/docs/api/_generated/authentication.md b/src/pages/docs/api/_generated/authentication.md index 7f0481611d..dd2c38d5b1 100644 --- a/src/pages/docs/api/_generated/authentication.md +++ b/src/pages/docs/api/_generated/authentication.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Authentication --- @@ -70,9 +70,7 @@ Provides the details of the enabled authentication providers. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OctopusIdDynamicRegistrationPending": false, "RememberMeEnabled": false, @@ -122,9 +120,7 @@ Determine whether an external server (.e.g Okta) has initiated login from a URL "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProviderName": "string", "WasLoginInitiated": false diff --git a/src/pages/docs/api/_generated/branches.md b/src/pages/docs/api/_generated/branches.md index 89981b6074..a2fc9d0c08 100644 --- a/src/pages/docs/api/_generated/branches.md +++ b/src/pages/docs/api/_generated/branches.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Branches --- @@ -33,7 +33,8 @@ Also reachable at `/api/projects/{projectId}/git/branches`, `/api/spaces/{spaceI - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanonicalName`** :span[string]{.type-label} Minimum length 1. @@ -63,7 +64,7 @@ Also reachable at `/api/projects/{projectId}/git/branches`, `/api/spaces/{spaceI ```json { "Id": "string", - "ItemType": "string", + "ItemType": "GitBranch", "Items": [ { "CanonicalName": "string", @@ -72,24 +73,20 @@ Also reachable at `/api/projects/{projectId}/git/branches`, `/api/spaces/{spaceI "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -153,9 +150,7 @@ Also reachable at `/api/projects/{projectId}/git/branches/v2`, `/api/spaces/{spa "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -206,9 +201,7 @@ Gets a named version control branch for a project. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -257,9 +250,7 @@ Gets a git commit for a project. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -310,9 +301,7 @@ Gets a named version control reference for a project. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -347,7 +336,8 @@ Also reachable at `/api/projects/{projectId}/git/tags`, `/api/spaces/{spaceIdent - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanonicalName`** :span[string]{.type-label} Minimum length 1. @@ -376,7 +366,7 @@ Also reachable at `/api/projects/{projectId}/git/tags`, `/api/spaces/{spaceIdent ```json { "Id": "string", - "ItemType": "string", + "ItemType": "GitTag", "Items": [ { "CanonicalName": "string", @@ -384,24 +374,20 @@ Also reachable at `/api/projects/{projectId}/git/tags`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -446,9 +432,7 @@ Also reachable at `/api/projects/{projectId}/git/tags/{tagName}`, `/api/spaces/{ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } diff --git a/src/pages/docs/api/_generated/build-information.md b/src/pages/docs/api/_generated/build-information.md index 8c8066f594..4337d238b1 100644 --- a/src/pages/docs/api/_generated/build-information.md +++ b/src/pages/docs/api/_generated/build-information.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Build Information --- @@ -40,7 +40,8 @@ Retrieve a list of build information records describing the vcs information for - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Branch`** :span[string]{.type-label} - **`BuildEnvironment`** :span[string]{.type-label} @@ -81,7 +82,7 @@ Retrieve a list of build information records describing the vcs information for ```json { "Id": "string", - "ItemType": "string", + "ItemType": "OctopusPackageVersionBuildInformationMapped", "Items": [ { "Branch": "string", @@ -98,9 +99,7 @@ Retrieve a list of build information records describing the vcs information for "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", @@ -113,17 +112,15 @@ Retrieve a list of build information records describing the vcs information for ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -242,9 +239,7 @@ Also reachable at `/api/build-information`, `/api/spaces/{spaceIdentifier}/build "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", @@ -367,9 +362,7 @@ Also reachable at `/api/build-information/{id}`, `/api/spaces/{spaceIdentifier}/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", diff --git a/src/pages/docs/api/_generated/certificates.md b/src/pages/docs/api/_generated/certificates.md index fda294ad3f..3a9f48d4cb 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-03 +modDate: 2026-09-04 title: Certificates --- @@ -43,7 +43,8 @@ Also reachable at `/api/certificates`, `/api/spaces/{spaceIdentifier}/certificat - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Archived`** :span[string]{.type-label} Format `date-time`. @@ -104,7 +105,7 @@ Also reachable at `/api/certificates`, `/api/spaces/{spaceIdentifier}/certificat ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Certificate", "Items": [ { "Archived": "2020-01-01T00:00:00.000Z", @@ -130,9 +131,7 @@ Also reachable at `/api/certificates`, `/api/spaces/{spaceIdentifier}/certificat "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -166,17 +165,15 @@ Also reachable at `/api/certificates`, `/api/spaces/{spaceIdentifier}/certificat "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -346,9 +343,7 @@ Adds a new certificate "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -503,9 +498,7 @@ Lists X.509 certificates managed by Octopus. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -571,9 +564,7 @@ Returns the server thumbprint used to identify this Octopus Server to any Tentac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SignatureAlgorithm": "string", @@ -692,9 +683,7 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -831,9 +820,7 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -875,7 +862,9 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c Also reachable at `/api/certificates/v2`, `/api/spaces/{spaceIdentifier}/certificates/v2`. -List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived. Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint. +List the X.509 certificates in the supplied Octopus Deploy Space in pages. Current certificates are sorted by soonest expiry first unless OrderBy says otherwise; archived certificates are always sorted by most recently archived. + +Skip and Take are required. TotalResults is always the real count of matching certificates, including when Tenant or FirstResult is supplied. Certificate data and passwords are never returned by this endpoint. **Path Parameters** @@ -905,7 +894,8 @@ List the X.509 certificates in the supplied Octopus Deploy Space in pages. Curre `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Archived`** :span[string]{.type-label} Format `date-time`. @@ -959,7 +949,7 @@ List the X.509 certificates in the supplied Octopus Deploy Space in pages. Curre :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "Certificate", "Items": [ { "Archived": "2020-01-01T00:00:00.000Z", @@ -985,9 +975,7 @@ List the X.509 certificates in the supplied Octopus Deploy Space in pages. Curre "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1021,10 +1009,10 @@ List the X.509 certificates in the supplied Octopus Deploy Space in pages. Curre "Version": 0 } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1142,9 +1130,7 @@ Also reachable at `/api/certificates/{id}`, `/api/spaces/{spaceIdentifier}/certi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1338,9 +1324,7 @@ Modifies an existing certificate "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1603,9 +1587,7 @@ Also reachable at `/api/certificates/{id}/replace`, `/api/spaces/{spaceIdentifie "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1846,7 +1828,9 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "EnvironmentIds": [ "Environments-1", @@ -1860,9 +1844,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1900,9 +1882,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -1914,9 +1894,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier } ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectUsages": [ { @@ -1955,9 +1933,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -2015,9 +1991,7 @@ Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -2061,7 +2035,8 @@ Only returns configurations for the global Certificate - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -2089,33 +2064,29 @@ Only returns configurations for the global Certificate ```json { "Id": "string", - "ItemType": "string", + "ItemType": "CertificateConfiguration", "Items": [ { "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SignatureAlgorithm": "string", "Thumbprint": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2152,9 +2123,7 @@ Only returns configurations for the global Certificate "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SignatureAlgorithm": "string", diff --git a/src/pages/docs/api/_generated/channels.md b/src/pages/docs/api/_generated/channels.md index f6bae66d7e..cc018f8d69 100644 --- a/src/pages/docs/api/_generated/channels.md +++ b/src/pages/docs/api/_generated/channels.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Channels --- @@ -101,9 +101,7 @@ Also reachable at `/api/channels`, `/api/spaces/{spaceIdentifier}/channels`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -201,9 +199,7 @@ Also reachable at `/api/channels`, `/api/spaces/{spaceIdentifier}/channels`. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -217,9 +213,7 @@ Also reachable at `/api/channels`, `/api/spaces/{spaceIdentifier}/channels`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -335,9 +329,7 @@ Lists all of the channels in the supplied Octopus Deploy Space. The results will "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -350,7 +342,9 @@ Lists all of the channels in the supplied Octopus Deploy Space. The results will "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Tag": "string", "VersionRange": "string", "VersionTagRegex": "string", @@ -747,9 +741,7 @@ Also reachable at `/api/channels/{id}`, `/api/spaces/{spaceIdentifier}/channels/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -846,9 +838,7 @@ Also reachable at `/api/channels/{id}`, `/api/spaces/{spaceIdentifier}/channels/ "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -862,9 +852,7 @@ Also reachable at `/api/channels/{id}`, `/api/spaces/{spaceIdentifier}/channels/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -930,7 +918,8 @@ Lists all the channels for the given project - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AutomaticEphemeralEnvironmentDeployments`** :span[boolean]{.type-label} - **`CustomFieldDefinitions`** :span[array of object]{.type-label} @@ -972,7 +961,7 @@ Lists all the channels for the given project ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Channel", "Items": [ { "AutomaticEphemeralEnvironmentDeployments": false, @@ -993,9 +982,7 @@ Lists all the channels for the given project "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1011,17 +998,15 @@ Lists all the channels for the given project "Type": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1123,9 +1108,7 @@ Also reachable at `/api/projects/{projectId}/channels`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -1223,9 +1206,7 @@ Also reachable at `/api/projects/{projectId}/channels`, `/api/spaces/{spaceIdent "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1239,9 +1220,7 @@ Also reachable at `/api/projects/{projectId}/channels`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -1423,9 +1402,7 @@ Also reachable at `/api/projects/{projectId}/channels/{id}`, `/api/spaces/{space "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1439,9 +1416,7 @@ Also reachable at `/api/projects/{projectId}/channels/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -1560,9 +1535,7 @@ Also reachable at `/api/projects/{projectId}/channels/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -1659,9 +1632,7 @@ Also reachable at `/api/projects/{projectId}/channels/{id}`, `/api/spaces/{space "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1675,9 +1646,7 @@ Also reachable at `/api/projects/{projectId}/channels/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", @@ -1776,7 +1745,8 @@ Lists all of the Channels in the supplied Octopus Deploy Space, from all project - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AutomaticEphemeralEnvironmentDeployments`** :span[boolean]{.type-label} - **`CustomFieldDefinitions`** :span[array of object]{.type-label} @@ -1818,7 +1788,7 @@ Lists all of the Channels in the supplied Octopus Deploy Space, from all project ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Channel", "Items": [ { "AutomaticEphemeralEnvironmentDeployments": false, @@ -1839,9 +1809,7 @@ Lists all of the Channels in the supplied Octopus Deploy Space, from all project "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1857,17 +1825,15 @@ Lists all of the Channels in the supplied Octopus Deploy Space, from all project "Type": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1968,9 +1934,7 @@ Also reachable at `/api/channels/{id}`, `/api/spaces/{spaceIdentifier}/channels/ "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ParentEnvironmentId": "Environments-1", @@ -1984,9 +1948,7 @@ Also reachable at `/api/channels/{id}`, `/api/spaces/{spaceIdentifier}/channels/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Tag": "string", "VersionRange": "string", diff --git a/src/pages/docs/api/_generated/community-action-templates.md b/src/pages/docs/api/_generated/community-action-templates.md index 92be7ee37f..18e2d6959d 100644 --- a/src/pages/docs/api/_generated/community-action-templates.md +++ b/src/pages/docs/api/_generated/community-action-templates.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Community Action Templates --- @@ -22,7 +22,8 @@ title: Community Action Templates - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Author`** :span[string]{.type-label} - **`Description`** :span[string]{.type-label} @@ -51,7 +52,7 @@ title: Community Action Templates ```json { "Id": "string", - "ItemType": "string", + "ItemType": "CommunityActionTemplate", "Items": [ { "Author": "string", @@ -80,17 +81,15 @@ title: Community Action Templates "Website": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -233,7 +232,7 @@ Also reachable at `/api/communityactiontemplates/{id}/actiontemplate`. **Path Parameters** - **`actiontemplatespaceId`** :span[string]{.type-label} *(required)* - Then ID of the space where the Action Template can be located. + The ID of the space where the Action Template can be located. - **`id`** :span[string]{.type-label} *(required)* The ID of the Community Action Template. @@ -317,9 +316,7 @@ Also reachable at `/api/communityactiontemplates/{id}/actiontemplate`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -484,9 +481,7 @@ Also reachable at `/api/communityactiontemplates/{id}/installation`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ @@ -651,9 +646,7 @@ Also reachable at `/api/communityactiontemplates/{id}/installation`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Packages": [ diff --git a/src/pages/docs/api/_generated/compliance-policies.md b/src/pages/docs/api/_generated/compliance-policies.md index e15834a114..48b20c7574 100644 --- a/src/pages/docs/api/_generated/compliance-policies.md +++ b/src/pages/docs/api/_generated/compliance-policies.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Compliance Policies --- @@ -88,7 +88,8 @@ title: Compliance Policies `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`GitCommit`** :span[string]{.type-label} @@ -120,7 +121,7 @@ title: Compliance Policies :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "CompliancePolicyVersion", "Items": [ { "Description": "string", @@ -138,10 +139,10 @@ title: Compliance Policies "ViolationReason": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/configuration.md b/src/pages/docs/api/_generated/configuration.md index 042343cef5..49053139b9 100644 --- a/src/pages/docs/api/_generated/configuration.md +++ b/src/pages/docs/api/_generated/configuration.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Configuration --- @@ -15,7 +15,8 @@ title: Configuration - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -43,7 +44,7 @@ title: Configuration ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ConfigurationSection", "Items": [ { "Description": "string", @@ -51,24 +52,20 @@ title: Configuration "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -105,9 +102,7 @@ title: Configuration "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } diff --git a/src/pages/docs/api/_generated/dashboard-configuration.md b/src/pages/docs/api/_generated/dashboard-configuration.md index ad773a71be..d75bf45c10 100644 --- a/src/pages/docs/api/_generated/dashboard-configuration.md +++ b/src/pages/docs/api/_generated/dashboard-configuration.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Dashboard Configuration --- @@ -73,9 +73,7 @@ Gets the dashboard configuration of the authenticated user for the current space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectLimit": 0, "SpaceId": "Spaces-1" @@ -208,9 +206,7 @@ Modifies the dashboard configuration for the current user per space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectLimit": 0, "SpaceId": "Spaces-1" diff --git a/src/pages/docs/api/_generated/dashboard.md b/src/pages/docs/api/_generated/dashboard.md index 1c508b0100..63b3c9dcb3 100644 --- a/src/pages/docs/api/_generated/dashboard.md +++ b/src/pages/docs/api/_generated/dashboard.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Dashboard --- @@ -137,9 +137,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -165,9 +163,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PendingInterruptionTypes": [ "ManualIntervention" @@ -188,9 +184,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroups": [ { @@ -202,9 +196,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -222,9 +214,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupId": "string", @@ -239,9 +229,7 @@ Also reachable at `/api/dashboard`, `/api/spaces/{spaceIdentifier}/dashboard`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -393,9 +381,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -421,9 +407,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PendingInterruptionTypes": [ "ManualIntervention" @@ -444,9 +428,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroups": [ { @@ -458,9 +440,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -478,9 +458,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupId": "string", @@ -495,9 +473,7 @@ Also reachable at `/api/dashboard/dynamic`, `/api/spaces/{spaceIdentifier}/dashb "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { diff --git a/src/pages/docs/api/_generated/deployment-freeze.md b/src/pages/docs/api/_generated/deployment-freeze.md index 562d1406a9..641df54a04 100644 --- a/src/pages/docs/api/_generated/deployment-freeze.md +++ b/src/pages/docs/api/_generated/deployment-freeze.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Deployment Freeze --- @@ -574,9 +574,7 @@ Also reachable at `/api/deployments/override`, `/api/spaces/{spaceIdentifier}/de "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -731,9 +729,7 @@ Also reachable at `/api/deployments/override`, `/api/spaces/{spaceIdentifier}/de "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/deployment-processes.md b/src/pages/docs/api/_generated/deployment-processes.md index c727d6b1fd..1f97d896da 100644 --- a/src/pages/docs/api/_generated/deployment-processes.md +++ b/src/pages/docs/api/_generated/deployment-processes.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-20 +modDate: 2026-09-04 title: Deployment Processes --- @@ -33,7 +33,8 @@ Lists all the deployment processes in the supplied Octopus Deploy Space, sorted - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -63,7 +64,7 @@ Lists all the deployment processes in the supplied Octopus Deploy Space, sorted ```json { "Id": "string", - "ItemType": "string", + "ItemType": "DeploymentProcess", "Items": [ { "Id": "string", @@ -71,9 +72,7 @@ Lists all the deployment processes in the supplied Octopus Deploy Space, sorted "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -83,17 +82,15 @@ Lists all the deployment processes in the supplied Octopus Deploy Space, sorted "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -191,9 +188,7 @@ Also reachable at `/api/deploymentprocesses/{deploymentProcessId}/template`, `/a "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastReleaseVersion": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextVersionIncrement": "string", "Packages": [ @@ -271,9 +266,7 @@ Also reachable at `/api/deploymentprocesses/{id}`, `/api/spaces/{spaceIdentifier "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -352,9 +345,7 @@ Also reachable at `/api/projects/{projectId}/deploymentprocesses`, `/api/spaces/ "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -489,9 +480,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -572,9 +561,7 @@ This request returns the deployment process with all process template usages res "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -695,9 +682,7 @@ Also reachable at `/api/projects/{projectId}/deploymentprocesses/template`, `/ap "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastReleaseVersion": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextVersionIncrement": "string", "Packages": [ @@ -818,9 +803,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/deploymentprocesses`, `/ap "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -958,9 +941,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -1042,9 +1023,7 @@ This request returns the deployment process with all process template usages res "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -1167,9 +1146,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/deploymentprocesses/templa "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastReleaseVersion": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextVersionIncrement": "string", "Packages": [ @@ -1295,9 +1272,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", @@ -1365,9 +1340,7 @@ Modifies a deployment process. Only allowed for deployment processes owned by a "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "SpaceId": "Spaces-1", diff --git a/src/pages/docs/api/_generated/deployment-settings.md b/src/pages/docs/api/_generated/deployment-settings.md index 868dba3ce4..7c00bf1dec 100644 --- a/src/pages/docs/api/_generated/deployment-settings.md +++ b/src/pages/docs/api/_generated/deployment-settings.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Deployment Settings --- @@ -72,9 +72,7 @@ Also reachable at `/api/projects/{projectId}/deploymentsettings`, `/api/spaces/{ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "ReleaseNotesTemplate": "string", @@ -158,9 +156,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/deploymentsettings`, `/api "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "ReleaseNotesTemplate": "string", @@ -319,9 +315,7 @@ Modifies deployment settings for a project. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "ReleaseNotesTemplate": "string", @@ -408,9 +402,7 @@ Also reachable at `/api/deploymentsettings/{id}`, `/api/spaces/{spaceIdentifier} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "ReleaseNotesTemplate": "string", @@ -568,9 +560,7 @@ Modifies deployment settings for a project. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "ReleaseNotesTemplate": "string", diff --git a/src/pages/docs/api/_generated/deployment-targets.md b/src/pages/docs/api/_generated/deployment-targets.md index 62bda81064..678caadcc3 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-03 +modDate: 2026-09-04 title: Deployment Targets --- @@ -59,7 +59,8 @@ List all the registered machines in the supplied Octopus Deploy Space, from all - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -109,7 +110,7 @@ List all the registered machines in the supplied Octopus Deploy Space, from all ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Machine", "Items": [ { "Architecture": "string", @@ -118,7 +119,9 @@ List all the registered machines in the supplied Octopus Deploy Space, from all "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "EnvironmentIds": [ "Environments-1", @@ -132,9 +135,7 @@ List all the registered machines in the supplied Octopus Deploy Space, from all "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -161,17 +162,15 @@ List all the registered machines in the supplied Octopus Deploy Space, from all "Uri": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -227,9 +226,7 @@ Creates a new deployment target. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -318,9 +315,7 @@ Creates a new deployment target. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -335,9 +330,7 @@ Creates a new deployment target. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -446,9 +439,7 @@ Lists all of the Deployment Targets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -463,9 +454,7 @@ Lists all of the Deployment Targets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -565,7 +554,9 @@ Lists all of the Deployment Targets in the supplied Space. The results will be s "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "EnvironmentIds": [ "Environments-1", @@ -579,9 +570,7 @@ Lists all of the Deployment Targets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -682,9 +671,7 @@ Also reachable at `/api/machines/discover`, `/api/spaces/{spaceIdentifier}/machi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -695,9 +682,7 @@ Also reachable at `/api/machines/discover`, `/api/spaces/{spaceIdentifier}/machi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -811,7 +796,8 @@ List all of the registered machines in the supplied Octopus Deploy Space, from a `200` — The list of alphabetically sorted deployment targets that matched the request. - **`DeploymentTargets`** :span[object]{.type-label} - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastPageNumber`** :span[integer]{.type-label} @@ -823,7 +809,7 @@ List all of the registered machines in the supplied Octopus Deploy Space, from a ```json { "DeploymentTargets": { - "ItemType": "string", + "ItemType": "Machine", "Items": [ { "Architecture": "string", @@ -839,7 +825,9 @@ List all of the registered machines in the supplied Octopus Deploy Space, from a "IsInProcess": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "MachinePolicyId": "string", "Name": "string", "OperatingSystem": "string", @@ -865,10 +853,10 @@ List all of the registered machines in the supplied Octopus Deploy Space, from a "Uri": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 }, "TargetCountPerHealthStatus": { "additionalProp1": 0, @@ -951,9 +939,7 @@ Also reachable at `/api/machines/{id}`, `/api/spaces/{spaceIdentifier}/machines/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -968,9 +954,7 @@ Also reachable at `/api/machines/{id}`, `/api/spaces/{spaceIdentifier}/machines/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1025,13 +1009,14 @@ Also reachable at `/api/machines/{id}/latestdeployments`, `/api/spaces/{spaceIde **Path Parameters** - **`id`** :span[string]{.type-label} *(required)* - ID of the Deployment Target. + The ID of the deployment target. - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). **Query Parameters** -- **`partialName`** :span[string]{.type-label} +- **`partialName`** :span[string]{.type-label} + Filters deployments by a partial project name. - **`skip`** :span[integer]{.type-label} Number of items to skip. Defaults to zero. Minimum `0`. - **`take`** :span[integer]{.type-label} @@ -1041,7 +1026,8 @@ Also reachable at `/api/machines/{id}/latestdeployments`, `/api/spaces/{spaceIde `200` — The requested list of latest deployments per project for the Deployment Target -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ProjectId`** :span[string]{.type-label} - **`ProjectLogo`** :span[string]{.type-label} @@ -1057,7 +1043,7 @@ Also reachable at `/api/machines/{id}/latestdeployments`, `/api/spaces/{spaceIde :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "LatestProjectDeployment", "Items": [ { "ProjectId": "Projects-1", @@ -1082,7 +1068,9 @@ Also reachable at `/api/machines/{id}/latestdeployments`, `/api/spaces/{spaceIde "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "PendingInterruptionTypes": [ "ManualIntervention" @@ -1100,10 +1088,10 @@ Also reachable at `/api/machines/{id}/latestdeployments`, `/api/spaces/{spaceIde } } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1119,7 +1107,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. **Path Parameters** - **`id`** :span[string]{.type-label} *(required)* - ID of the Deployment Target. + The ID of the deployment target. - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). @@ -1130,7 +1118,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. - **`take`** :span[integer]{.type-label} Number of items to take. Defaults to 30. Minimum `0`. - **`type`** :span[enum]{.type-label} - The type of Task to retrieve. If left blank, all Tasks are retrieved. + Filters the tasks by task type. Allowed values: `Deployment`, `RunbookRun`. **Response** @@ -1139,7 +1127,8 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Arguments`** :span[object]{.type-label} Gets or sets any arguments to the task. @@ -1214,7 +1203,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Task", "Items": [ { "Arguments": { @@ -1240,9 +1229,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -1260,17 +1247,15 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. "State": "Queued" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1286,7 +1271,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. **Path Parameters** - **`id`** :span[string]{.type-label} *(required)* - ID of the Deployment Target. + The ID of the deployment target. - **`spaceId`** :span[string]{.type-label} *(required)* The ID of the space containing the resource(s). @@ -1297,7 +1282,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. - **`take`** :span[integer]{.type-label} Number of items to take. Defaults to 30. Minimum `0`. - **`type`** :span[enum]{.type-label} - The type of Task to retrieve. If left blank, all Tasks are retrieved. + Filters the tasks by task type. Allowed values: `Deployment`, `RunbookRun`. **Response** @@ -1307,7 +1292,8 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. - **`ResourceCollection`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -1325,7 +1311,7 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. { "ResourceCollection": { "Id": "string", - "ItemType": "string", + "ItemType": "Task", "Items": [ { "Arguments": {}, @@ -1346,7 +1332,9 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "PendingInterruptionTypes": [ "ManualIntervention" @@ -1363,17 +1351,15 @@ Get a history of related Tasks (ie. Deployments) for a Deployment Target. "State": "Queued" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` @@ -1478,9 +1464,7 @@ Also reachable at `/api/machines/{machineid}`, `/api/spaces/{spaceIdentifier}/ma "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -1569,9 +1553,7 @@ Also reachable at `/api/machines/{machineid}`, `/api/spaces/{spaceIdentifier}/ma "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "EnvironmentIds": [ @@ -1586,9 +1568,7 @@ Also reachable at `/api/machines/{machineid}`, `/api/spaces/{spaceIdentifier}/ma "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/deployments.md b/src/pages/docs/api/_generated/deployments.md index f3c9c454e8..de0e32c00f 100644 --- a/src/pages/docs/api/_generated/deployments.md +++ b/src/pages/docs/api/_generated/deployments.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Deployments --- @@ -46,7 +46,8 @@ Lists all of the Deployments in the supplied Space. The results will be sorted f - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Changes`** :span[array of object]{.type-label} @@ -114,7 +115,7 @@ Lists all of the Deployments in the supplied Space. The results will be sorted f ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Deployment", "Items": [ { "ChangeRequestSettings": [ @@ -159,9 +160,7 @@ Lists all of the Deployments in the supplied Space. The results will be sorted f "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -191,17 +190,15 @@ Lists all of the Deployments in the supplied Space. The results will be sorted f "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -347,9 +344,7 @@ Also reachable at `/api/deployments`, `/api/spaces/{spaceIdentifier}/deployments "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -514,9 +509,7 @@ Also reachable at `/api/deployments`, `/api/spaces/{spaceIdentifier}/deployments "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -937,9 +930,7 @@ Also reachable at `/api/deployments/v1`, `/api/spaces/{spaceIdentifier}/deployme "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1088,9 +1079,7 @@ Also reachable at `/api/deployments/v1`, `/api/spaces/{spaceIdentifier}/deployme "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1268,9 +1257,7 @@ Also reachable at `/api/deployments/{id}`, `/api/spaces/{spaceIdentifier}/deploy "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/environments.md b/src/pages/docs/api/_generated/environments.md index e9f39e110b..6df7e7dab6 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-03 +modDate: 2026-09-04 title: Environments --- @@ -37,7 +37,8 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AllowDynamicInfrastructure`** :span[boolean]{.type-label} If set to true, deployments to this environment will be allowed to contain steps that manage infrastructure. This relies on DeploymentActionResource being set to allow managing resource for a step. @@ -77,7 +78,7 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Environment", "Items": [ { "AllowDynamicInfrastructure": false, @@ -92,9 +93,7 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -103,17 +102,15 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -214,9 +211,7 @@ Also reachable at `/api/environments`, `/api/spaces/{spaceIdentifier}/environmen "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -298,9 +293,7 @@ Lists the name and ID of all of the environments in the supplied Space. The resu "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -380,9 +373,7 @@ Lists the name and ID of all of the environments in the supplied Space. The resu "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -504,7 +495,9 @@ Also reachable at `/api/environments/summary`, `/api/spaces/{spaceIdentifier}/en "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "Slug": "string", "SortOrder": 0, @@ -587,22 +580,36 @@ Also reachable at `/api/spaces/{spaceIdentifier}/environments/summary/v2`. **Query Parameters** -- **`commStyles`** :span[array of string]{.type-label} -- **`deploymentTargetTypes`** :span[array of string]{.type-label} -- **`environmentTags`** :span[array of string]{.type-label} -- **`healthStatuses`** :span[array of string]{.type-label} -- **`hideEmptyEnvironments`** :span[boolean]{.type-label} -- **`ids`** :span[array of string]{.type-label} -- **`isDisabled`** :span[boolean]{.type-label} -- **`machinePartialName`** :span[string]{.type-label} -- **`partialName`** :span[string]{.type-label} -- **`roles`** :span[array of string]{.type-label} -- **`shellNames`** :span[array of string]{.type-label} -- **`targetTags`** :span[array of string]{.type-label} -- **`tenantIds`** :span[array of string]{.type-label} -- **`tenantTags`** :span[array of string]{.type-label} +- **`commStyles`** :span[array of string]{.type-label} + Filters deployment targets by communication style. +- **`deploymentTargetTypes`** :span[array of string]{.type-label} + Filters deployment targets by endpoint type ID. +- **`environmentTags`** :span[array of string]{.type-label} + Filters environment summaries by environment tag. +- **`healthStatuses`** :span[array of string]{.type-label} + Filters deployment targets by health status. +- **`hideEmptyEnvironments`** :span[boolean]{.type-label} + Excludes environments with no matching deployment targets. +- **`ids`** :span[array of string]{.type-label} + Filters environment summaries by environment ID. +- **`isDisabled`** :span[boolean]{.type-label} + Filters deployment targets by whether they are disabled. +- **`machinePartialName`** :span[string]{.type-label} + Filters deployment targets by a partial name. +- **`partialName`** :span[string]{.type-label} + Filters environment summaries by a partial environment name. +- **`roles`** :span[array of string]{.type-label} + Filters deployment targets by role. +- **`shellNames`** :span[array of string]{.type-label} + Filters deployment targets by shell name. +- **`targetTags`** :span[array of string]{.type-label} + Filters deployment targets by target tag. +- **`tenantIds`** :span[array of string]{.type-label} + Filters deployment targets by tenant ID. +- **`tenantTags`** :span[array of string]{.type-label} + Filters deployment targets by tenant tag. - **`type`** :span[array of string]{.type-label} - Filters the environment summaries using the specified environment EnvironmentType. + Filters environment summaries by EnvironmentType. **Response** @@ -750,7 +757,8 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results - **`Environments`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -768,7 +776,7 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results { "Environments": { "Id": "string", - "ItemType": "string", + "ItemType": "Environment", "Items": [ { "AllowDynamicInfrastructure": false, @@ -782,7 +790,9 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "Slug": "string", "SortOrder": 0, @@ -790,17 +800,15 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` @@ -838,7 +846,8 @@ List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Sp `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} 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. @@ -859,7 +868,7 @@ List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Sp :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "BaseEnvironmentV2", "Items": [ { "Description": "string", @@ -873,10 +882,10 @@ List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Sp "Type": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -980,9 +989,7 @@ Also reachable at `/api/environments/{environmentId}`, `/api/spaces/{spaceIdenti "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1136,9 +1143,7 @@ Also reachable at `/api/environments/{id}`, `/api/spaces/{spaceIdentifier}/envir "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1202,7 +1207,8 @@ Also reachable at `/api/environments/{id}/machines`, `/api/spaces/{spaceIdentifi - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -1252,7 +1258,7 @@ Also reachable at `/api/environments/{id}/machines`, `/api/spaces/{spaceIdentifi ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Machine", "Items": [ { "Architecture": "string", @@ -1261,7 +1267,9 @@ Also reachable at `/api/environments/{id}/machines`, `/api/spaces/{spaceIdentifi "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "EnvironmentIds": [ "Environments-1", @@ -1275,9 +1283,7 @@ Also reachable at `/api/environments/{id}/machines`, `/api/spaces/{spaceIdentifi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1304,17 +1310,15 @@ Also reachable at `/api/environments/{id}/machines`, `/api/spaces/{spaceIdentifi "Uri": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1386,13 +1390,14 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environmen - **`take`** :span[integer]{.type-label} *(required)* Number of items to take. Defaults to 30. Minimum `0`. - **`type`** :span[array of string]{.type-label} - Filters the environments by EnvironmentType. + Filters environments by EnvironmentType. **Response** `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} 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. @@ -1413,7 +1418,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environmen :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "BaseEnvironmentV2", "Items": [ { "Description": "string", @@ -1427,10 +1432,10 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environmen "Type": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/event-retention.md b/src/pages/docs/api/_generated/event-retention.md index 0f487e201f..af0bd8ab61 100644 --- a/src/pages/docs/api/_generated/event-retention.md +++ b/src/pages/docs/api/_generated/event-retention.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Event Retention --- @@ -22,7 +22,8 @@ title: Event Retention - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CreatedDate`** :span[string]{.type-label} Format `date-time`. @@ -53,7 +54,7 @@ title: Event Retention ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ArchivedEventFile", "Items": [ { "CreatedDate": "2020-01-01T00:00:00.000Z", @@ -62,25 +63,21 @@ title: Event Retention "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ModifiedDate": "2020-01-01T00:00:00.000Z", "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -103,7 +100,8 @@ title: Event Retention - **`ArchivedFiles`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -121,7 +119,7 @@ title: Event Retention { "ArchivedFiles": { "Id": "string", - "ItemType": "string", + "ItemType": "ArchivedEventFile", "Items": [ { "CreatedDate": "2020-01-01T00:00:00.000Z", @@ -129,22 +127,22 @@ title: Event Retention "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "ModifiedDate": "2020-01-01T00:00:00.000Z", "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` diff --git a/src/pages/docs/api/_generated/events.md b/src/pages/docs/api/_generated/events.md index d5b2aca4e2..9cb9ddc4fb 100644 --- a/src/pages/docs/api/_generated/events.md +++ b/src/pages/docs/api/_generated/events.md @@ -1,11 +1,18 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Events --- -## Get a list of events +Events are automatically created when significant actions take place within Octopus by users. + +Examples are adding environments, modifying projects, deploying releases, canceling tasks, and so on. +Events can be used to provide an audit trail of what has happened in the system. + +The HTTP API **cannot** be used to add, modify or delete events. + +## List Events :endpoint{method="GET" path="/api/\{spaceId\}/events"} @@ -67,43 +74,178 @@ A list of all audit events collected to date, ordered by the date of the event i **Response** -`200` — OK +`200` — A paginated list of events, unless AsCsv is true, in which case a text/csv file is returned + +- **`Id`** :span[string]{.type-label} + Gets or sets a unique identifier for this resource. +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. +- **`Items`** :span[array of object]{.type-label} + - **`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} + Gets or sets the ID of the API key used to authenticate the request, if applicable. + - **`Category`** :span[string]{.type-label} + Gets or sets the event category. + - **`ChangeDetails`** :span[object]{.type-label} + - **`Comments`** :span[string]{.type-label} + Gets or sets any user-provided comments that were recorded with the event. + - **`Details`** :span[string]{.type-label} + Gets or sets the details of the event. For events representing a modification to a document use the ChangeDetails property. + - **`Id`** :span[string]{.type-label} + Gets or sets a unique identifier for this resource. + - **`IdentityEstablishedWith`** :span[string]{.type-label} + Gets or sets a description of how the user performing the event identified themselves to Octopus. + - **`IpAddress`** :span[string]{.type-label} + The IP address of the user that created the event. + - **`IsService`** :span[boolean]{.type-label} + Gets or sets whether the user who created the event is a service user or an interactive user. + - **`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. + - **`Message`** :span[string]{.type-label} + Gets or sets the message text that summarizes the event. + - **`MessageHtml`** :span[string]{.type-label} + Gets or sets the message text that summarizes the event, HTML formatted with links to the related documents. + - **`MessageReferences`** :span[array of object]{.type-label} + 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`. + - **`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. + - **`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} + Gets or sets the user agent header value from the request that triggered the event. + - **`UserId`** :span[string]{.type-label} + Gets or sets the ID of the user who created the event. + - **`Username`** :span[string]{.type-label} + Gets or sets the name of the user who created the event. +- **`ItemsPerPage`** :span[integer]{.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`. +- **`LastPageNumber`** :span[integer]{.type-label} +- **`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. +- **`NumberOfPages`** :span[integer]{.type-label} +- **`TotalResults`** :span[integer]{.type-label} + +:::api-example{label="Response"} +```json +{ + "Id": "string", + "ItemType": "Event", + "Items": [ + { + "ApiKeyHint": null, + "ApiKeyId": null, + "Category": "Modified", + "ChangeDetails": { + "Differences": [ + { + "path": "/IsDisabled", + "op": "replace", + "value": true + } + ], + "DocumentContext": { + "Id": "Tenants-1", + "Name": "ExampleTenant" + } + }, + "Comments": "string", + "Details": "string", + "Id": "string", + "IdentityEstablishedWith": "Session cookie", + "IpAddress": "127.0.0.1", + "IsService": false, + "LastModifiedBy": "string", + "LastModifiedOn": "2020-01-01T00:00:00.000Z", + "Links": { + "Self": "/api/..." + }, + "Message": "Tenant ExampleTenant was modified", + "MessageHtml": "Tenant ExampleTenant was modified", + "MessageReferences": [ + {} + ], + "Occurred": "2020-01-01T00:00:00.000Z", + "RelatedDocumentIds": [ + "Tenants-1" + ], + "SpaceId": "Spaces-1", + "UserAgent": "OctopusClient-js/2026.3.15581", + "UserId": "Users-1", + "Username": "MyUserName" + } + ], + "ItemsPerPage": 30, + "LastModifiedBy": "string", + "LastModifiedOn": "2020-01-01T00:00:00.000Z", + "LastPageNumber": 1, + "Links": { + "Self": "/api/..." + }, + "NumberOfPages": 2, + "TotalResults": 42 +} +``` +::: -## Return the list of event agents +## List Event Agents :endpoint{method="GET" path="/api/\{spaceId\}/events/agents"} Also reachable at `/api/events/agents`, `/api/spaces/{spaceIdentifier}/events/agents`. +An Event Agent represents a source of events. Agents are either well known, or remote. + +Well-known agents are represented in the response list by an Id and Name: + +``` +{ "Id": "Server", "Name": "Octopus Server task" } +``` + +Remote agents are represented in the response list by their HTTP User-Agent: + +``` +{ "Id": "curl/8.7.1", "Name": "curl/8.7.1" } +``` + **Path Parameters** -- **`spaceId`** :span[string]{.type-label} *(required)* +- **`spaceId`** :span[string]{.type-label} *(required)* + Ignored. All Event Agents known to the system are returned. **Response** `200` — The requested event agents -- **`Id`** :span[string]{.type-label} -- **`Links`** :span[object]{.type-label} -- **`Name`** :span[string]{.type-label} +- **`Id`** :span[string]{.type-label} + A well-known identifier for a source of Events, or the HTTP User-Agent of a remote client which generated one or more events. +- **`Links`** :span[object]{.type-label} + The Links property is not set but exists for backwards compatibility. +- **`Name`** :span[string]{.type-label} + A well-known name for a source of Events, or the HTTP User-Agent of a remote client which generated one or more events. :::api-example{label="Response"} ```json [ { - "Id": "string", - "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" - }, - "Name": "string" + "Id": "curl/8.7.1", + "Links": null, + "Name": "curl/8.7.1" } ] ``` ::: -## List event categories +## List Event Categories :endpoint{method="GET" path="/api/\{spaceId\}/events/categories"} @@ -111,75 +253,82 @@ Also reachable at `/api/events/categories`, `/api/spaces/{spaceIdentifier}/event **Path Parameters** -- **`spaceId`** :span[string]{.type-label} *(required)* +- **`spaceId`** :span[string]{.type-label} *(required)* + Ignored. **Query Parameters** -- **`appliesTo`** :span[string]{.type-label} +- **`appliesTo`** :span[string]{.type-label} + Limits the results to event categories that apply to a particular document type. **Response** `200` — The requested Event Categories -- **`Id`** :span[string]{.type-label} -- **`Links`** :span[object]{.type-label} -- **`Name`** :span[string]{.type-label} +- **`Id`** :span[string]{.type-label} + The ID of the Event Category. +- **`Links`** :span[object]{.type-label} + The Links property is not set but exists for backwards compatibility. +- **`Name`** :span[string]{.type-label} + The display name of the Event Category. :::api-example{label="Response"} ```json [ { - "Id": "string", - "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" - }, - "Name": "string" + "Id": "Created", + "Links": null, + "Name": "Document created" } ] ``` ::: -## List subscription event document types +## List Document Types :endpoint{method="GET" path="/api/\{spaceId\}/events/documenttypes"} Also reachable at `/api/events/documenttypes`, `/api/spaces/{spaceIdentifier}/events/documenttypes`. +The list of document types that you can use for the documentTypes parameter when searching for events. Use the Document Type Id. + **Path Parameters** - **`spaceId`** :span[string]{.type-label} *(required)* - The ID of the space containing the resource(s). + Ignored. **Response** -`200` — A list of subscription event document types. +`200` — List of event document types. -- **`Id`** :span[string]{.type-label} -- **`Name`** :span[string]{.type-label} +- **`Id`** :span[string]{.type-label} + Document Type Identifier. +- **`Name`** :span[string]{.type-label} + Display name for the Document Type. :::api-example{label="Response"} ```json [ { - "Id": "string", - "Name": "string" + "Id": "ProjectGroups", + "Name": "Project Group" } ] ``` ::: -## List subscription event groups +## List Event Groups :endpoint{method="GET" path="/api/\{spaceId\}/events/groups"} Also reachable at `/api/events/groups`, `/api/spaces/{spaceIdentifier}/events/groups`. +The list of event groups that you can use when searching for events + **Path Parameters** - **`spaceId`** :span[string]{.type-label} *(required)* - The ID of the space containing the resource(s). + Ignored. **Query Parameters** @@ -200,15 +349,13 @@ Also reachable at `/api/events/groups`, `/api/spaces/{spaceIdentifier}/events/gr [ { "EventCategories": [ - "string" + "Created", + "Modified", + "Deleted" ], - "Id": "string", - "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" - }, - "Name": "string" + "Id": "Document", + "Links": null, + "Name": "Document events" } ] ``` @@ -283,28 +430,35 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} :::api-example{label="Response"} ```json { - "ApiKeyHint": "string", - "ApiKeyId": "string", - "Category": "string", + "ApiKeyHint": null, + "ApiKeyId": null, + "Category": "Modified", "ChangeDetails": { - "Differences": "string", - "DocumentContext": "string" + "Differences": [ + { + "path": "/IsDisabled", + "op": "replace", + "value": true + } + ], + "DocumentContext": { + "Id": "Tenants-1", + "Name": "ExampleTenant" + } }, "Comments": "string", "Details": "string", "Id": "string", - "IdentityEstablishedWith": "string", - "IpAddress": "string", + "IdentityEstablishedWith": "Session cookie", + "IpAddress": "127.0.0.1", "IsService": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "Message": "string", - "MessageHtml": "string", + "Message": "Tenant ExampleTenant was modified", + "MessageHtml": "Tenant ExampleTenant was modified", "MessageReferences": [ { "Length": 0, @@ -314,12 +468,12 @@ Also reachable at `/api/events/{id}`, `/api/spaces/{spaceIdentifier}/events/{id} ], "Occurred": "2020-01-01T00:00:00.000Z", "RelatedDocumentIds": [ - "string" + "Tenants-1" ], "SpaceId": "Spaces-1", - "UserAgent": "string", - "UserId": "string", - "Username": "string" + "UserAgent": "OctopusClient-js/2026.3.15581", + "UserId": "Users-1", + "Username": "MyUserName" } ``` ::: diff --git a/src/pages/docs/api/_generated/features-configuration.md b/src/pages/docs/api/_generated/features-configuration.md index ff2a682c1a..bd76d87580 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-08-11 +modDate: 2026-09-04 title: Features Configuration --- @@ -20,7 +20,6 @@ Gets the features configuration of the current instance - **`HelpSidebarSupportLinkLabel`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`IsAutomaticStepUpdatesEnabled`** :span[boolean]{.type-label} - **`IsBuiltInWorkerEnabled`** :span[boolean]{.type-label} - **`IsCommunityActionTemplatesEnabled`** :span[boolean]{.type-label} - **`IsCompositeDockerHubRegistryFeedEnabled`** :span[boolean]{.type-label} @@ -46,7 +45,6 @@ Gets the features configuration of the current instance "HelpSidebarSupportLink": "string", "HelpSidebarSupportLinkLabel": "string", "Id": "string", - "IsAutomaticStepUpdatesEnabled": false, "IsBuiltInWorkerEnabled": false, "IsCommunityActionTemplatesEnabled": false, "IsCompositeDockerHubRegistryFeedEnabled": false, @@ -61,9 +59,7 @@ Gets the features configuration of the current instance "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -85,8 +81,6 @@ Updates the features configuration of the current instance Custom label for the help sidebar support link. - **`Id`** :span[string]{.type-label} The id of features configuration resource. -- **`IsAutomaticStepUpdatesEnabled`** :span[boolean]{.type-label} - Enable automatic step updates feature. - **`IsBuiltInWorkerEnabled`** :span[boolean]{.type-label} Enable built-in worker feature. - **`IsCommunityActionTemplatesEnabled`** :span[boolean]{.type-label} @@ -119,7 +113,6 @@ Updates the features configuration of the current instance "HelpSidebarSupportLink": "string", "HelpSidebarSupportLinkLabel": "string", "Id": "string", - "IsAutomaticStepUpdatesEnabled": false, "IsBuiltInWorkerEnabled": false, "IsCommunityActionTemplatesEnabled": false, "IsCompositeDockerHubRegistryFeedEnabled": false, @@ -145,7 +138,6 @@ Updates the features configuration of the current instance - **`HelpSidebarSupportLinkLabel`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`IsAutomaticStepUpdatesEnabled`** :span[boolean]{.type-label} - **`IsBuiltInWorkerEnabled`** :span[boolean]{.type-label} - **`IsCommunityActionTemplatesEnabled`** :span[boolean]{.type-label} - **`IsCompositeDockerHubRegistryFeedEnabled`** :span[boolean]{.type-label} @@ -171,7 +163,6 @@ Updates the features configuration of the current instance "HelpSidebarSupportLink": "string", "HelpSidebarSupportLinkLabel": "string", "Id": "string", - "IsAutomaticStepUpdatesEnabled": false, "IsBuiltInWorkerEnabled": false, "IsCommunityActionTemplatesEnabled": false, "IsCompositeDockerHubRegistryFeedEnabled": false, @@ -186,9 +177,7 @@ Updates the features configuration of the current instance "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` diff --git a/src/pages/docs/api/_generated/feeds.md b/src/pages/docs/api/_generated/feeds.md index c04c9796a3..552da526f0 100644 --- a/src/pages/docs/api/_generated/feeds.md +++ b/src/pages/docs/api/_generated/feeds.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Feeds --- @@ -37,7 +37,8 @@ Also reachable at `/api/feeds`, `/api/spaces/{spaceIdentifier}/feeds`. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`FeedType`** :span[enum]{.type-label} Allowed values: `None`, `NuGet`, `Docker`, `Maven`, `OctopusProject`, `GitHub`, `Helm`, `OciRegistry`, `AwsElasticContainerRegistry`, `BuiltIn`, `S3`, `AzureContainerRegistry`, `GoogleContainerRegistry`, `ArtifactoryGeneric`, `Npm`, `GcsStorage`, `PyPi`. @@ -69,7 +70,7 @@ Also reachable at `/api/feeds`, `/api/spaces/{spaceIdentifier}/feeds`. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Feed", "Items": [ { "FeedType": "None", @@ -77,9 +78,7 @@ Also reachable at `/api/feeds`, `/api/spaces/{spaceIdentifier}/feeds`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PackageAcquisitionLocationOptions": [ @@ -89,17 +88,15 @@ Also reachable at `/api/feeds`, `/api/spaces/{spaceIdentifier}/feeds`. "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -206,9 +203,7 @@ Also reachable at `/api/feeds`, `/api/spaces/{spaceIdentifier}/feeds`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PackageAcquisitionLocationOptions": [ @@ -260,9 +255,7 @@ Also reachable at `/api/feeds/all`, `/api/spaces/{spaceIdentifier}/feeds/all`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PackageAcquisitionLocationOptions": [ @@ -307,9 +300,7 @@ Also reachable at `/api/feeds/stats`, `/api/spaces/{spaceIdentifier}/feeds/stats "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "TotalPackages": 0 } @@ -357,9 +348,7 @@ Also reachable at `/api/feeds/{id}`, `/api/spaces/{spaceIdentifier}/feeds/{id}`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PackageAcquisitionLocationOptions": [ @@ -478,9 +467,7 @@ Also reachable at `/api/feeds/{id}`, `/api/spaces/{spaceIdentifier}/feeds/{id}`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PackageAcquisitionLocationOptions": [ @@ -539,7 +526,8 @@ Also reachable at `/api/feeds/{id}/packages/search`, `/api/spaces/{spaceIdentifi - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -561,7 +549,7 @@ Also reachable at `/api/feeds/{id}/packages/search`, `/api/spaces/{spaceIdentifi ```json { "Id": "string", - "ItemType": "string", + "ItemType": "PackageDescription", "Items": [ { "Description": "string", @@ -575,17 +563,15 @@ Also reachable at `/api/feeds/{id}/packages/search`, `/api/spaces/{spaceIdentifi "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -618,7 +604,7 @@ Also reachable at `/api/feeds/{id}/packages/versions`, `/api/spaces/{spaceIdenti - **`skip`** :span[integer]{.type-label} Number of items to skip. Defaults to zero. Minimum `0`. - **`take`** :span[integer]{.type-label} - Number of items to take. Defaults to 30. Minimum `0`. + Number of items to take. Defaults to 20. Minimum `0`. - **`versionRange`** :span[string]{.type-label} The range of versions to filter by. - **`versionTagRegex`** :span[string]{.type-label} @@ -632,7 +618,8 @@ Also reachable at `/api/feeds/{id}/packages/versions`, `/api/spaces/{spaceIdenti - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`FeedId`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -662,7 +649,7 @@ Also reachable at `/api/feeds/{id}/packages/versions`, `/api/spaces/{spaceIdenti ```json { "Id": "string", - "ItemType": "string", + "ItemType": "PackageVersion", "Items": [ { "FeedId": "string", @@ -680,17 +667,15 @@ Also reachable at `/api/feeds/{id}/packages/versions`, `/api/spaces/{spaceIdenti "Version": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/git-hub.md b/src/pages/docs/api/_generated/git-hub.md index 84415bbbad..232d415fe4 100644 --- a/src/pages/docs/api/_generated/git-hub.md +++ b/src/pages/docs/api/_generated/git-hub.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Git Hub --- @@ -513,7 +513,8 @@ https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-re `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`DefaultBranch`** :span[string]{.type-label} - **`GitUrl`** :span[string]{.type-label} @@ -531,7 +532,7 @@ https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-re :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "GitHubRepositoryResponse", "Items": [ { "DefaultBranch": "string", @@ -544,10 +545,10 @@ https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-re "Visibility": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -590,7 +591,8 @@ https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repos `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`DefaultBranch`** :span[string]{.type-label} - **`GitUrl`** :span[string]{.type-label} @@ -608,7 +610,7 @@ https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repos :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "GitHubRepositoryResponse", "Items": [ { "DefaultBranch": "string", @@ -621,10 +623,10 @@ https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repos "Visibility": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/home.md b/src/pages/docs/api/_generated/home.md index 02454bc403..a7fd164c37 100644 --- a/src/pages/docs/api/_generated/home.md +++ b/src/pages/docs/api/_generated/home.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Home --- @@ -36,9 +36,7 @@ Returns a document describing the specified Space and links to other parts of th "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -84,9 +82,7 @@ Returns a document describing the current Octopus Server and links to other part "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Version": "string" } diff --git a/src/pages/docs/api/_generated/insights.md b/src/pages/docs/api/_generated/insights.md index 127eccbb0d..02f899c712 100644 --- a/src/pages/docs/api/_generated/insights.md +++ b/src/pages/docs/api/_generated/insights.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Insights --- @@ -31,7 +31,8 @@ Returns a paginated list of the Insights Reports in the supplied Octopus Deploy - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AllTenants`** :span[boolean]{.type-label} - **`ChannelIds`** :span[array of string]{.type-label} @@ -72,7 +73,7 @@ Returns a paginated list of the Insights Reports in the supplied Octopus Deploy ```json { "Id": "string", - "ItemType": "string", + "ItemType": "InsightsReport", "Items": [ { "AllTenants": false, @@ -90,9 +91,7 @@ Returns a paginated list of the Insights Reports in the supplied Octopus Deploy "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -115,17 +114,15 @@ Returns a paginated list of the Insights Reports in the supplied Octopus Deploy "TimeZone": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -269,9 +266,7 @@ Creates a new Insights Report. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -434,9 +429,7 @@ Creates a new Insights Report. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -530,9 +523,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/insights/reports/{id}`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -703,9 +694,7 @@ Updates an existing Insights Report "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -816,9 +805,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/insights/reports/{id}/v1`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ @@ -989,9 +976,7 @@ Updates an existing Insights Report "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectGroupIds": [ diff --git a/src/pages/docs/api/_generated/interruptions.md b/src/pages/docs/api/_generated/interruptions.md index aa612d1231..4cc88c03f4 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-03 +modDate: 2026-09-04 title: Interruptions --- @@ -34,7 +34,8 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanTakeResponsibility`** :span[boolean]{.type-label} Gets or sets a value indicating whether the current user has permissions to take responsibility for this interruption. @@ -88,7 +89,7 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Interruption", "Items": [ { "CanTakeResponsibility": false, @@ -107,9 +108,7 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PullRequests": [ {} @@ -127,17 +126,15 @@ Also reachable at `/api/interruptions`, `/api/spaces/{spaceIdentifier}/interrupt "Type": "ManualIntervention" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -236,9 +233,7 @@ Also reachable at `/api/interruptions/{id}`, `/api/spaces/{spaceIdentifier}/inte "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PullRequests": [ { @@ -354,9 +349,7 @@ Only users in one of the responsible teams on this interruption can take respons "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -489,9 +482,7 @@ Only the user with responsibility for this interruption can submit this form. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PullRequests": [ { diff --git a/src/pages/docs/api/_generated/invitations.md b/src/pages/docs/api/_generated/invitations.md index 90669cc189..05a8ee8255 100644 --- a/src/pages/docs/api/_generated/invitations.md +++ b/src/pages/docs/api/_generated/invitations.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Invitations --- @@ -66,9 +66,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/users/invitations`, `/api/users "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SpaceId": "Spaces-1" } @@ -119,9 +117,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/users/invitations/{id}`, `/api/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SpaceId": "Spaces-1" } diff --git a/src/pages/docs/api/_generated/lets-encrypt.md b/src/pages/docs/api/_generated/lets-encrypt.md index b36023ee30..051c5c60e8 100644 --- a/src/pages/docs/api/_generated/lets-encrypt.md +++ b/src/pages/docs/api/_generated/lets-encrypt.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Lets Encrypt --- @@ -48,9 +48,7 @@ To configure the Let's Encrypt integration, see https://octopus.com/docs/securit "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Path": "string", "RegistrationEmailAddress": "string" @@ -62,7 +60,13 @@ To configure the Let's Encrypt integration, see https://octopus.com/docs/securit :endpoint{method="PUT" path="/api/letsencryptconfiguration"} -To re-enable Let's Encrypt you must go through the configuration process again. If the integration is enabled, set `Enabled: false` to disable it. If you set `Enabled: true` when it is already enabled, or `Enabled: false` when it is already disabled, no changes occur. If you set `Enabled: true` when the integration is disabled, an error is returned. +To re-enable Let's Encrypt you must go through the configuration process again. + +If the integration is enabled, set `Enabled: false` to disable it. + +If you set `Enabled: true` when it is already enabled, or `Enabled: false` when it is already disabled, no changes occur. + +If you set `Enabled: true` when the integration is disabled, an error is returned. **Request Body** @@ -113,9 +117,7 @@ To re-enable Let's Encrypt you must go through the configuration process again. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Path": "string", "RegistrationEmailAddress": "string" diff --git a/src/pages/docs/api/_generated/library-variable-sets.md b/src/pages/docs/api/_generated/library-variable-sets.md index ee799bcf58..24b0dc813c 100644 --- a/src/pages/docs/api/_generated/library-variable-sets.md +++ b/src/pages/docs/api/_generated/library-variable-sets.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Library Variable Sets --- @@ -36,7 +36,8 @@ List all the library variable sets in the supplied Octopus Deploy Space. The res - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ContentType`** :span[enum]{.type-label} Describes the purpose of the variable set. Clients can use this to offer an editing experience appropriately. @@ -75,7 +76,7 @@ List all the library variable sets in the supplied Octopus Deploy Space. The res ```json { "Id": "string", - "ItemType": "string", + "ItemType": "LibraryVariableSet", "Items": [ { "ContentType": "Variables", @@ -84,9 +85,7 @@ List all the library variable sets in the supplied Octopus Deploy Space. The res "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -97,17 +96,15 @@ List all the library variable sets in the supplied Octopus Deploy Space. The res "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -212,9 +209,7 @@ Also reachable at `/api/libraryvariablesets`, `/api/spaces/{spaceIdentifier}/lib "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -305,9 +300,7 @@ Lists all the Library Variable Sets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -387,9 +380,7 @@ Lists all the Library Variable Sets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -461,9 +452,7 @@ Lists all the Library Variable Sets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -537,9 +526,7 @@ Lists all the Library Variable Sets in the supplied Space. The results will be s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -608,9 +595,7 @@ Also reachable at `/api/libraryvariablesets/{id}`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -739,9 +724,7 @@ Also reachable at `/api/libraryvariablesets/{id}`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", diff --git a/src/pages/docs/api/_generated/licenses.md b/src/pages/docs/api/_generated/licenses.md index d5ba1ab5d7..719a27e5c2 100644 --- a/src/pages/docs/api/_generated/licenses.md +++ b/src/pages/docs/api/_generated/licenses.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Licenses --- @@ -32,9 +32,7 @@ title: Licenses "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LicenseText": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SerialNumber": "string" } @@ -84,9 +82,7 @@ Updates the license for the Octopus cluster. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LicenseText": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SerialNumber": "string" } @@ -207,9 +203,7 @@ Calculates the status of the current Octopus license including compliance and ma } ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Messages": [ { @@ -290,9 +284,7 @@ Calculates the usage of the current Octopus server. } ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SpacesUsage": [ { diff --git a/src/pages/docs/api/_generated/lifecycles.md b/src/pages/docs/api/_generated/lifecycles.md index e65a4b7624..a727de3852 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-03 +modDate: 2026-09-04 title: Lifecycles --- @@ -34,7 +34,8 @@ List the Lifecycles in the supplied Octopus Deploy Space in pages. The results w - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -66,7 +67,7 @@ List the Lifecycles in the supplied Octopus Deploy Space in pages. The results w ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Lifecycle", "Items": [ { "Description": "string", @@ -74,9 +75,7 @@ List the Lifecycles in the supplied Octopus Deploy Space in pages. The results w "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -98,17 +97,15 @@ List the Lifecycles in the supplied Octopus Deploy Space in pages. The results w } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -257,9 +254,7 @@ Also reachable at `/api/lifecycles`, `/api/spaces/{spaceIdentifier}/lifecycles`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -367,9 +362,7 @@ Also reachable at `/api/lifecycles/all`, `/api/spaces/{spaceIdentifier}/lifecycl "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -474,9 +467,7 @@ Also reachable at `/api/lifecycles/previews`, `/api/spaces/{spaceIdentifier}/lif "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -577,9 +568,7 @@ This request does not support getting Lifecycles that belong to Templated Projec "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -778,9 +767,7 @@ Also reachable at `/api/lifecycles/{id}`, `/api/spaces/{spaceIdentifier}/lifecyc "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -913,9 +900,7 @@ Also reachable at `/api/lifecycles/{id}/preview`, `/api/spaces/{spaceIdentifier} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Phases": [ @@ -1109,9 +1094,7 @@ Also reachable at `/api/lifecycles/{id}/projects`, `/api/spaces/{spaceIdentifier "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { diff --git a/src/pages/docs/api/_generated/machine-policies.md b/src/pages/docs/api/_generated/machine-policies.md index e9a13298a0..e6e23e1cc8 100644 --- a/src/pages/docs/api/_generated/machine-policies.md +++ b/src/pages/docs/api/_generated/machine-policies.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Machine Policies --- @@ -35,7 +35,8 @@ Get a paginated list of the Machine Policies in the supplied Octopus Deploy Spac - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ConnectionConnectTimeout`** :span[string]{.type-label} Format `date-span`. @@ -79,7 +80,7 @@ Get a paginated list of the Machine Policies in the supplied Octopus Deploy Spac ```json { "Id": "string", - "ItemType": "string", + "ItemType": "MachinePolicy", "Items": [ { "ConnectionConnectTimeout": "string", @@ -92,9 +93,7 @@ Get a paginated list of the Machine Policies in the supplied Octopus Deploy Spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -134,17 +133,15 @@ Get a paginated list of the Machine Policies in the supplied Octopus Deploy Spac "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -350,9 +347,7 @@ Also reachable at `/api/machinepolicies`, `/api/spaces/{spaceIdentifier}/machine "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -490,9 +485,7 @@ Also reachable at `/api/machinepolicies/all`, `/api/spaces/{spaceIdentifier}/mac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -630,9 +623,7 @@ Also reachable at `/api/machinepolicies/template`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -772,9 +763,7 @@ Also reachable at `/api/machinepolicies/{id}`, `/api/spaces/{spaceIdentifier}/ma "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -1030,9 +1019,7 @@ Also reachable at `/api/machinepolicies/{id}`, `/api/spaces/{spaceIdentifier}/ma "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachineCleanupPolicy": { "DeleteMachinesBehavior": "DoNotDelete", @@ -1123,7 +1110,8 @@ Also reachable at `/api/machinepolicies/{id}/machines`, `/api/spaces/{spaceIdent - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -1173,7 +1161,7 @@ Also reachable at `/api/machinepolicies/{id}/machines`, `/api/spaces/{spaceIdent ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Machine", "Items": [ { "Architecture": "string", @@ -1182,7 +1170,9 @@ Also reachable at `/api/machinepolicies/{id}/machines`, `/api/spaces/{spaceIdent "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "EnvironmentIds": [ "Environments-1", @@ -1196,9 +1186,7 @@ Also reachable at `/api/machinepolicies/{id}/machines`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1225,17 +1213,15 @@ Also reachable at `/api/machinepolicies/{id}/machines`, `/api/spaces/{spaceIdent "Uri": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1289,7 +1275,8 @@ Also reachable at `/api/machinepolicies/{id}/workers`, `/api/spaces/{spaceIdenti - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -1334,7 +1321,7 @@ Also reachable at `/api/machinepolicies/{id}/workers`, `/api/spaces/{spaceIdenti ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Worker", "Items": [ { "Architecture": "string", @@ -1343,7 +1330,9 @@ Also reachable at `/api/machinepolicies/{id}/workers`, `/api/spaces/{spaceIdenti "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "HasLatestCalamari": false, "HealthStatus": "Healthy", @@ -1353,9 +1342,7 @@ Also reachable at `/api/machinepolicies/{id}/workers`, `/api/spaces/{spaceIdenti "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1375,17 +1362,15 @@ Also reachable at `/api/machinepolicies/{id}/workers`, `/api/spaces/{spaceIdenti ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/machines.md b/src/pages/docs/api/_generated/machines.md index 6a383408cb..ddf5561dea 100644 --- a/src/pages/docs/api/_generated/machines.md +++ b/src/pages/docs/api/_generated/machines.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Machines --- @@ -14,7 +14,7 @@ Also reachable at `/api/machines/{id}/connection`, `/api/spaces/{spaceIdentifier **Path Parameters** - **`id`** :span[string]{.type-label} *(required)* - ID of the machine whose connection status is being requested. + The ID of the machine whose connection status is requested. - **`spaceId`** :span[string]{.type-label} *(required)* ID of the space. @@ -53,9 +53,7 @@ Also reachable at `/api/machines/{id}/connection`, `/api/spaces/{spaceIdentifier "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Logs": [ { diff --git a/src/pages/docs/api/_generated/maintenance-configuration.md b/src/pages/docs/api/_generated/maintenance-configuration.md index 816d2e61da..ffd02071b0 100644 --- a/src/pages/docs/api/_generated/maintenance-configuration.md +++ b/src/pages/docs/api/_generated/maintenance-configuration.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Maintenance Configuration --- @@ -31,9 +31,7 @@ title: Maintenance Configuration "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -77,9 +75,7 @@ title: Maintenance Configuration "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -125,9 +121,7 @@ title: Maintenance Configuration "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } } diff --git a/src/pages/docs/api/_generated/migrations.md b/src/pages/docs/api/_generated/migrations.md index 8e96452124..a3c3ac3eea 100644 --- a/src/pages/docs/api/_generated/migrations.md +++ b/src/pages/docs/api/_generated/migrations.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-31 +modDate: 2026-09-04 title: Migrations --- @@ -133,9 +133,7 @@ The import API lets you import a migration package from your Octopus Server's bu "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OverwriteExisting": false, "PackageFeedSpaceId": "Spaces-1", @@ -261,9 +259,7 @@ Using the partial-export API, we can export one or more of our projects and choo "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "MyAwesomeOctopusMigration", "PackageVersion": "1.0.0", diff --git a/src/pages/docs/api/_generated/nuget.md b/src/pages/docs/api/_generated/nuget.md index 0c8e4bc8c8..91b0b518cb 100644 --- a/src/pages/docs/api/_generated/nuget.md +++ b/src/pages/docs/api/_generated/nuget.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Nuget --- @@ -79,9 +79,7 @@ Also reachable at `/api/nuget/packages`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -106,9 +104,7 @@ Also reachable at `/api/nuget/packages`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", diff --git a/src/pages/docs/api/_generated/octopus-server-nodes.md b/src/pages/docs/api/_generated/octopus-server-nodes.md index e5e3771e55..5dcee87d39 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-08-11 +modDate: 2026-09-04 title: Octopus Server Nodes --- @@ -28,7 +28,8 @@ Lists all of the Octopus Server Nodes participating in the current Octopus Serve - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -56,7 +57,7 @@ Lists all of the Octopus Server Nodes participating in the current Octopus Serve ```json { "Id": "string", - "ItemType": "string", + "ItemType": "OctopusServerNode", "Items": [ { "Id": "string", @@ -64,25 +65,21 @@ Lists all of the Octopus Server Nodes participating in the current Octopus Serve "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "Name": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -118,9 +115,7 @@ Lists the name and ID of all Octopus Server nodes "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "Name": "string" @@ -165,9 +160,7 @@ Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSeen": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "Name": "string", @@ -226,9 +219,7 @@ Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSeen": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "MaxSqlConnectionPoolSize": 0, @@ -275,9 +266,7 @@ Returns HTTP ImATeapot (418) when the Octopus Server node is draining or offline "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "Name": "string" @@ -339,9 +328,7 @@ Modifies an existing Octopus Server node. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaxConcurrentTasks": 0, "Name": "string" @@ -398,9 +385,7 @@ Modifies an existing Octopus Server node. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "RunningTasks": 0 } diff --git a/src/pages/docs/api/_generated/packages.md b/src/pages/docs/api/_generated/packages.md index 9ea4d5a1dc..2e1493b683 100644 --- a/src/pages/docs/api/_generated/packages.md +++ b/src/pages/docs/api/_generated/packages.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Packages --- @@ -95,9 +95,7 @@ Also reachable at `/api/feeds/{feedId}/packages`, `/api/spaces/{spaceIdentifier} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -117,9 +115,7 @@ Also reachable at `/api/feeds/{feedId}/packages`, `/api/spaces/{spaceIdentifier} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", @@ -204,7 +200,8 @@ Also reachable at `/api/packages`, `/api/spaces/{spaceIdentifier}/packages`. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`FeedId`** :span[string]{.type-label} @@ -244,7 +241,7 @@ Also reachable at `/api/packages`, `/api/spaces/{spaceIdentifier}/packages`. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "PackageFromBuiltInFeed", "Items": [ { "Description": "string", @@ -255,9 +252,7 @@ Also reachable at `/api/packages`, `/api/spaces/{spaceIdentifier}/packages`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -277,7 +272,9 @@ Also reachable at `/api/packages`, `/api/spaces/{spaceIdentifier}/packages`. "IssueTrackerName": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "PackageId": "string", "VcsCommitNumber": "string", "VcsCommitUrl": "string", @@ -295,17 +292,15 @@ Also reachable at `/api/packages`, `/api/spaces/{spaceIdentifier}/packages`. "Version": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -423,9 +418,7 @@ Also reachable at `/api/packages/notes`, `/api/spaces/{spaceIdentifier}/packages "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Packages": [ { @@ -519,9 +512,7 @@ Also reachable at `/api/packages/raw`, `/api/spaces/{spaceIdentifier}/packages/r "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -546,9 +537,7 @@ Also reachable at `/api/packages/raw`, `/api/spaces/{spaceIdentifier}/packages/r "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", @@ -678,9 +667,7 @@ Also reachable at `/api/packages/{id}`, `/api/spaces/{spaceIdentifier}/packages/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -704,9 +691,7 @@ Also reachable at `/api/packages/{id}`, `/api/spaces/{spaceIdentifier}/packages/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", @@ -873,9 +858,7 @@ Also reachable at `/api/packages/{packageId}/{baseVersion}/delta`, `/api/spaces/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NuGetFeedId": "string", "NuGetPackageId": "string", @@ -900,9 +883,7 @@ Also reachable at `/api/packages/{packageId}/{baseVersion}/delta`, `/api/spaces/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PackageId": "string", "VcsCommitNumber": "string", diff --git a/src/pages/docs/api/_generated/performance.md b/src/pages/docs/api/_generated/performance.md index a193bd4916..0c259ec96b 100644 --- a/src/pages/docs/api/_generated/performance.md +++ b/src/pages/docs/api/_generated/performance.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Performance --- @@ -32,9 +32,7 @@ title: Performance "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -80,9 +78,7 @@ title: Performance "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` diff --git a/src/pages/docs/api/_generated/platform-hub.md b/src/pages/docs/api/_generated/platform-hub.md index 8ea194955f..c561f2685a 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-03 +modDate: 2026-09-04 title: Platform Hub --- @@ -24,7 +24,8 @@ title: Platform Hub `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Details`** :span[object]{.type-label} @@ -41,7 +42,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubAccount", "Items": [ { "Description": "string", @@ -53,10 +54,10 @@ title: Platform Hub "Slug": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -225,7 +226,8 @@ title: Platform Hub `200` — The requested Platform Hub certificates. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Archived`** :span[string]{.type-label} Format `date-time`. @@ -275,7 +277,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubCertificate", "Items": [ { "Archived": "2020-01-01T00:00:00.000Z", @@ -297,9 +299,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -325,10 +325,10 @@ title: Platform Hub "Version": 0 } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -465,9 +465,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -590,9 +588,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -713,9 +709,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -843,9 +837,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -992,9 +984,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1202,9 +1192,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "NotAfter": "2020-01-01T00:00:00.000Z", @@ -1351,9 +1339,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProcessTemplateVersionUsageCount": 0, "ProcessTemplateVersionUsages": [ @@ -1405,7 +1391,8 @@ title: Platform Hub `200` — The requested list of Platform Hub Feeds -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`FeedType`** :span[enum]{.type-label} Allowed values: `None`, `NuGet`, `Docker`, `Maven`, `OctopusProject`, `GitHub`, `Helm`, `OciRegistry`, `AwsElasticContainerRegistry`, `BuiltIn`, `S3`, `AzureContainerRegistry`, `GoogleContainerRegistry`, `ArtifactoryGeneric`, `Npm`, `GcsStorage`, `PyPi`. @@ -1427,7 +1414,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubFeed", "Items": [ { "FeedType": "None", @@ -1441,10 +1428,10 @@ title: Platform Hub "Slug": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1668,7 +1655,8 @@ title: Platform Hub `200` — Returns a paginated collection of searched package descriptions in platform hub -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -1683,7 +1671,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubPackageDescription", "Items": [ { "Description": "string", @@ -1692,10 +1680,10 @@ title: Platform Hub "Name": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1732,7 +1720,8 @@ title: Platform Hub `200` — Contains a paginated collection of package versions returned from a search -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`FeedId`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -1754,7 +1743,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubPackageVersion", "Items": [ { "FeedId": "string", @@ -1767,10 +1756,10 @@ title: Platform Hub "Version": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1792,7 +1781,8 @@ title: Platform Hub `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Details`** :span[object]{.type-label} @@ -1808,7 +1798,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubGitCredential", "Items": [ { "Description": "string", @@ -1825,10 +1815,10 @@ title: Platform Hub } } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1904,7 +1894,8 @@ title: Platform Hub `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Details`** :span[object]{.type-label} @@ -1920,7 +1911,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "PlatformHubGitCredentialV2", "Items": [ { "Description": "string", @@ -1937,10 +1928,10 @@ title: Platform Hub } } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2221,7 +2212,8 @@ title: Platform Hub `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanonicalName`** :span[string]{.type-label} Minimum length 1. @@ -2244,7 +2236,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "GitBranch", "Items": [ { "CanonicalName": "string", @@ -2253,17 +2245,15 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2314,9 +2304,7 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -2340,7 +2328,8 @@ title: Platform Hub `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanonicalName`** :span[string]{.type-label} Minimum length 1. @@ -2362,7 +2351,7 @@ title: Platform Hub :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "GitTag", "Items": [ { "CanonicalName": "string", @@ -2370,17 +2359,15 @@ title: Platform Hub "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/progression.md b/src/pages/docs/api/_generated/progression.md index c5485f7c3b..2aa98bba1a 100644 --- a/src/pages/docs/api/_generated/progression.md +++ b/src/pages/docs/api/_generated/progression.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Progression --- @@ -38,7 +38,8 @@ Return a list of runbook dashboard items, filtered by various criteria including - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CompletedTime`** :span[string]{.type-label} Format `date-time`. @@ -93,7 +94,7 @@ Return a list of runbook dashboard items, filtered by various criteria including ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbooksDashboardItem", "Items": [ { "CompletedTime": "2020-01-01T00:00:00.000Z", @@ -113,9 +114,7 @@ Return a list of runbook dashboard items, filtered by various criteria including "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PendingInterruptionTypes": [ "ManualIntervention" @@ -137,17 +136,15 @@ Return a list of runbook dashboard items, filtered by various criteria including "TenantId": "Tenants-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -195,9 +192,7 @@ Also reachable at `/api/progression/runbooks/{runbookId}`, `/api/spaces/{spaceId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "RunbookRuns": { "additionalProp1": [ @@ -215,7 +210,9 @@ Also reachable at `/api/progression/runbooks/{runbookId}`, `/api/spaces/{spaceId "IsCompleted": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "PendingInterruptionTypes": [ "ManualIntervention" ], @@ -251,7 +248,9 @@ Also reachable at `/api/progression/runbooks/{runbookId}`, `/api/spaces/{spaceId "IsCompleted": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "PendingInterruptionTypes": [ "ManualIntervention" ], @@ -287,7 +286,9 @@ Also reachable at `/api/progression/runbooks/{runbookId}`, `/api/spaces/{spaceId "IsCompleted": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "PendingInterruptionTypes": [ "ManualIntervention" ], @@ -356,9 +357,7 @@ Also reachable at `/api/progression/runbooks/{runbookId}/v1`, `/api/spaces/{spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "RunbookRuns": { "additionalProp1": [ @@ -473,9 +472,7 @@ Also reachable at `/api/progression/{projectId}`, `/api/projects/{projectId}/pro ] }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Releases": [ { @@ -497,7 +494,9 @@ Also reachable at `/api/progression/{projectId}`, `/api/projects/{projectId}/pro "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "ParentEnvironmentId": "Environments-1", "ProjectId": "Projects-1", @@ -541,7 +540,9 @@ Also reachable at `/api/progression/{projectId}`, `/api/projects/{projectId}/pro "LibraryVariableSetSnapshotIds": [ "string" ], - "Links": {}, + "Links": { + "Self": "/api/..." + }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", "ProjectVariableSetSnapshotId": "string", @@ -647,9 +648,7 @@ Also reachable at `/api/projects/{projectId}/progression/v1`, `/api/spaces/{spac ] }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Releases": [ { diff --git a/src/pages/docs/api/_generated/project-groups.md b/src/pages/docs/api/_generated/project-groups.md index 117d1946bb..2d616b8b8e 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-03 +modDate: 2026-09-04 title: Project Groups --- @@ -37,7 +37,8 @@ Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`EnvironmentIds`** :span[array of string]{.type-label} @@ -71,7 +72,7 @@ Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ProjectGroup", "Items": [ { "Description": "string", @@ -82,9 +83,7 @@ Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RetentionPolicyId": "string", @@ -92,17 +91,15 @@ Get a paginated list of the Project Groups in the supplied Octopus Deploy Space. "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -172,9 +169,7 @@ Also reachable at `/api/projectgroups`, `/api/spaces/{spaceIdentifier}/projectgr "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RetentionPolicyId": "string", @@ -230,9 +225,7 @@ List the name and ID of all of the Project Groups in the supplied Octopus Deploy "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RetentionPolicyId": "string", @@ -289,9 +282,7 @@ Also reachable at `/api/projectgroups/{id}`, `/api/spaces/{spaceIdentifier}/proj "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RetentionPolicyId": "string", @@ -371,9 +362,7 @@ Also reachable at `/api/projectgroups/{id}`, `/api/spaces/{spaceIdentifier}/proj "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RetentionPolicyId": "string", @@ -426,7 +415,8 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AllowIgnoreChannelRules`** :span[boolean]{.type-label} - **`AutoCreateRelease`** :span[boolean]{.type-label} @@ -493,7 +483,7 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Project", "Items": [ { "AllowIgnoreChannelRules": false, @@ -531,9 +521,7 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -575,17 +563,15 @@ Also reachable at `/api/projectgroups/{id}/projects`, `/api/spaces/{spaceIdentif } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/project-triggers.md b/src/pages/docs/api/_generated/project-triggers.md index 13957cbbc4..ebbafa03cc 100644 --- a/src/pages/docs/api/_generated/project-triggers.md +++ b/src/pages/docs/api/_generated/project-triggers.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Project Triggers --- @@ -43,7 +43,8 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Action`** :span[object]{.type-label} - **`Description`** :span[string]{.type-label} @@ -75,7 +76,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ProjectTrigger", "Items": [ { "Action": { @@ -83,7 +84,9 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "Description": "string", "Filter": { @@ -91,33 +94,31 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "Id": "string", "IsDisabled": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -179,9 +180,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -191,9 +190,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "IsDisabled": false, @@ -253,9 +250,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -265,9 +260,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -275,9 +268,7 @@ Also reachable at `/api/projects/{projectId}/triggers`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", @@ -350,9 +341,7 @@ Also reachable at `/api/projects/{projectId}/triggers/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -362,9 +351,7 @@ Also reachable at `/api/projects/{projectId}/triggers/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -372,9 +359,7 @@ Also reachable at `/api/projects/{projectId}/triggers/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", @@ -446,9 +431,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -458,9 +441,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "ProjectTriggers-1", @@ -521,9 +502,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -533,9 +512,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -543,9 +520,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", @@ -607,7 +582,8 @@ Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Action`** :span[object]{.type-label} - **`Description`** :span[string]{.type-label} @@ -639,7 +615,7 @@ Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ProjectTrigger", "Items": [ { "Action": { @@ -647,7 +623,9 @@ Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "Description": "string", "Filter": { @@ -655,33 +633,31 @@ Gets all the Project Triggers in the supplied Octopus Deploy Space, sorted by Id "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "Id": "string", "IsDisabled": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -741,9 +717,7 @@ Also reachable at `/api/projecttriggers`, `/api/spaces/{spaceIdentifier}/project "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -753,9 +727,7 @@ Also reachable at `/api/projecttriggers`, `/api/spaces/{spaceIdentifier}/project "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "IsDisabled": false, @@ -815,9 +787,7 @@ Also reachable at `/api/projecttriggers`, `/api/spaces/{spaceIdentifier}/project "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -827,9 +797,7 @@ Also reachable at `/api/projecttriggers`, `/api/spaces/{spaceIdentifier}/project "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -837,9 +805,7 @@ Also reachable at `/api/projecttriggers`, `/api/spaces/{spaceIdentifier}/project "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", @@ -910,9 +876,7 @@ Also reachable at `/api/projecttriggers/{id}`, `/api/spaces/{spaceIdentifier}/pr "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -922,9 +886,7 @@ Also reachable at `/api/projecttriggers/{id}`, `/api/spaces/{spaceIdentifier}/pr "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -932,9 +894,7 @@ Also reachable at `/api/projecttriggers/{id}`, `/api/spaces/{spaceIdentifier}/pr "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", @@ -1004,9 +964,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -1016,9 +974,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "ProjectTriggers-1", @@ -1079,9 +1035,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Description": "string", @@ -1091,9 +1045,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "string", @@ -1101,9 +1053,7 @@ Updates an existing project trigger "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectId": "string", diff --git a/src/pages/docs/api/_generated/projects.md b/src/pages/docs/api/_generated/projects.md index ebe4139a05..089140915b 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-03 +modDate: 2026-09-04 title: Projects --- @@ -36,7 +36,8 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AllowIgnoreChannelRules`** :span[boolean]{.type-label} - **`AutoCreateRelease`** :span[boolean]{.type-label} @@ -103,7 +104,7 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Project", "Items": [ { "AllowIgnoreChannelRules": false, @@ -141,9 +142,7 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -185,17 +184,15 @@ List all the projects in the supplied Octopus Deploy Space, from all project gro } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -251,7 +248,7 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. - **`TargetRoles`** :span[array of string]{.type-label} - **`ProjectGroupId`** :span[string]{.type-label} *(required)* - **`ProjectTags`** :span[array of string]{.type-label} - Tags to apply to the project, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). Call find_tag_sets to discover which tag sets apply to projects and what tags they contain. + Tags to apply to the project, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). Find the tag sets first to discover which ones apply to projects and what tags they contain. - **`ReleaseCreationStrategy`** :span[object]{.type-label} - **`ChannelId`** :span[string]{.type-label} - **`ReleaseCreationPackage`** :span[object]{.type-label} @@ -493,9 +490,7 @@ Also reachable at `/api/projects`, `/api/spaces/{spaceIdentifier}/projects`. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -709,9 +704,7 @@ List all of the projects in the supplied Octopus Deploy Space. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -934,9 +927,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/projects/{projectId}/{unuse "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -1032,7 +1023,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr - **`DefaultToSkipIfAlreadyInstalled`** :span[boolean]{.type-label} - **`DeploymentChangesTemplate`** :span[string]{.type-label} - **`DeprovisioningRunbookId`** :span[string]{.type-label} - ID of a runbook in this project that tears down an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments. + ID of a runbook in this project that tears down an ephemeral environment. Must be an existing runbook of this project; find the project's runbooks to look one up. Only relevant to projects using ephemeral environments. - **`Description`** :span[string]{.type-label} - **`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). @@ -1062,9 +1053,9 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr - **`ProjectId`** :span[string]{.type-label} *(required)* ID of the project to modify. - **`ProjectTags`** :span[array of string]{.type-label} - The project's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). This replaces the project's current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to projects. + The project's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Regions/us-east"). This replaces the project's current tags, so resubmit the existing ones you want to keep. Find the tag sets first to discover which ones apply to projects. - **`ProvisioningRunbookId`** :span[string]{.type-label} - ID of a runbook in this project that provisions an ephemeral environment. Must be an existing runbook of this project; call find_runbooks to look one up. Only relevant to projects using ephemeral environments. + ID of a runbook in this project that provisions an ephemeral environment. Must be an existing runbook of this project; find the project's runbooks to look one up. Only relevant to projects using ephemeral environments. - **`ReleaseCreationStrategy`** :span[object]{.type-label} - **`ChannelId`** :span[string]{.type-label} - **`ReleaseCreationPackage`** :span[object]{.type-label} @@ -1309,9 +1300,7 @@ Also reachable at `/api/projects/{projectId}`, `/api/spaces/{spaceIdentifier}/pr "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LifecycleId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PersistenceSettings": { @@ -1868,9 +1857,7 @@ Also reachable at `/api/projects/{projectId}/git/validate`, `/api/spaces/{spaceI "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } diff --git a/src/pages/docs/api/_generated/proxies.md b/src/pages/docs/api/_generated/proxies.md index 8c4d04a9af..bcf4c69a9b 100644 --- a/src/pages/docs/api/_generated/proxies.md +++ b/src/pages/docs/api/_generated/proxies.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Proxies --- @@ -34,7 +34,8 @@ Lists all of the Proxies in the supplied Octopus Deploy Space. The results will - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Host`** :span[string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -66,7 +67,7 @@ Lists all of the Proxies in the supplied Octopus Deploy Space. The results will ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Proxy", "Items": [ { "Host": "string", @@ -74,9 +75,7 @@ Lists all of the Proxies in the supplied Octopus Deploy Space. The results will "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Password": { @@ -90,17 +89,15 @@ Lists all of the Proxies in the supplied Octopus Deploy Space. The results will "Username": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -183,9 +180,7 @@ Also reachable at `/api/proxies`, `/api/spaces/{spaceIdentifier}/proxies`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Password": { @@ -246,9 +241,7 @@ Lists the name and ID of all of the Proxies in the supplied Octopus Deploy Space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Password": { @@ -309,9 +302,7 @@ Also reachable at `/api/proxies/{id}`, `/api/spaces/{spaceIdentifier}/proxies/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Password": { @@ -410,9 +401,7 @@ Also reachable at `/api/proxies/{id}`, `/api/spaces/{spaceIdentifier}/proxies/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Password": { diff --git a/src/pages/docs/api/_generated/rate-limiting.md b/src/pages/docs/api/_generated/rate-limiting.md index 2b3db5f9bd..ec0b2af68d 100644 --- a/src/pages/docs/api/_generated/rate-limiting.md +++ b/src/pages/docs/api/_generated/rate-limiting.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Rate Limiting --- @@ -9,11 +9,14 @@ Rate Limiting policies can be configured via the API. See https://octopus.com/docs/administration/managing-infrastructure/rate-limiting to understand the feature and what the settings mean. -## List all rate limiting policies +## List rate limiting policies :endpoint{method="GET" path="/api/ratelimitingpolicies"} -There are three builtin policies, so while this returns a paginated response, there is only ever a single page. - Unauthenticated requests - Authenticated requests - AI Agent requests +There are three builtin policies: +- Unauthenticated requests +- Authenticated requests +- AI Agent requests **Query Parameters** @@ -26,7 +29,8 @@ There are three builtin policies, so while this returns a paginated response, th `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`AuditMode`** :span[boolean]{.type-label} When enabled, the policy logs requests that would be rate limited without rejecting them (no 429 response). @@ -52,7 +56,7 @@ There are three builtin policies, so while this returns a paginated response, th :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "RateLimitingPolicy", "Items": [ { "AuditMode": false, @@ -62,13 +66,13 @@ There are three builtin policies, so while this returns a paginated response, th "IsEnabled": false, "Name": "Authenticated requests", "RequestsPerMinute": 600, - "ScopeType": "string" + "ScopeType": "AuthenticatedHuman" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -113,7 +117,7 @@ There are three builtin policies, so while this returns a paginated response, th "IsEnabled": false, "Name": "Authenticated requests", "RequestsPerMinute": 600, - "ScopeType": "string" + "ScopeType": "AuthenticatedHuman" } ``` ::: @@ -153,7 +157,7 @@ There are three builtin policies, so while this returns a paginated response, th "IsEnabled": false, "Name": "Authenticated requests", "RequestsPerMinute": 600, - "ScopeType": "string" + "ScopeType": "AuthenticatedHuman" } ``` ::: @@ -189,7 +193,7 @@ There are three builtin policies, so while this returns a paginated response, th "IsEnabled": false, "Name": "Authenticated requests", "RequestsPerMinute": 600, - "ScopeType": "string" + "ScopeType": "AuthenticatedHuman" } ``` ::: diff --git a/src/pages/docs/api/_generated/releases.md b/src/pages/docs/api/_generated/releases.md index b5d81dee0d..beeaf2373c 100644 --- a/src/pages/docs/api/_generated/releases.md +++ b/src/pages/docs/api/_generated/releases.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Releases --- @@ -37,7 +37,8 @@ Releases will be ordered from most recent to least recent, - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -82,7 +83,7 @@ Releases will be ordered from most recent to least recent, ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Release", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -103,9 +104,7 @@ Releases will be ordered from most recent to least recent, "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -127,17 +126,15 @@ Releases will be ordered from most recent to least recent, } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -174,7 +171,8 @@ Releases will be ordered from most recent to least recent, - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -219,7 +217,7 @@ Releases will be ordered from most recent to least recent, ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Release", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -240,9 +238,7 @@ Releases will be ordered from most recent to least recent, "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -264,17 +260,15 @@ Releases will be ordered from most recent to least recent, } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -309,7 +303,8 @@ Releases will be ordered from most recent to least recent - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -354,7 +349,7 @@ Releases will be ordered from most recent to least recent ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Release", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -375,9 +370,7 @@ Releases will be ordered from most recent to least recent "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -399,17 +392,15 @@ Releases will be ordered from most recent to least recent } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -478,9 +469,7 @@ Also reachable at `/api/projects/{projectId}/releases/{id}/variables`, `/api/spa "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -649,9 +638,7 @@ Also reachable at `/api/projects/{projectId}/releases/{version}`, `/api/spaces/{ "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -713,7 +700,8 @@ Lists all of the Releases in the supplied Octopus Deploy Space, from all project - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -758,7 +746,7 @@ Lists all of the Releases in the supplied Octopus Deploy Space, from all project ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Release", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -779,9 +767,7 @@ Lists all of the Releases in the supplied Octopus Deploy Space, from all project "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -803,17 +789,15 @@ Lists all of the Releases in the supplied Octopus Deploy Space, from all project } } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -994,9 +978,7 @@ Also reachable at `/api/releases`, `/api/spaces/{spaceIdentifier}/releases`. "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -1051,7 +1033,7 @@ Also reachable at `/api/releases/create/v1`, `/api/spaces/{spaceIdentifier}/rele - **`GitCommit`** :span[string]{.type-label} Only set alongside GitRef, when a specific commit is needed; GitRef alone uses the tip of that ref. - **`GitRef`** :span[string]{.type-label} - The Git branch, tag or commit to snapshot the deployment process from. Required for a project that stores its configuration in Git, and must be left unset for one stored in the database — the command fails either way round. List a project's branches with get_branches. + The Git branch, tag or commit to snapshot the deployment process from. Required for a project that stores its configuration in Git, and must be left unset for one stored in the database — the command fails either way round. Find the project's branches first when you need a branch reference. - **`GitResources`** :span[array of string]{.type-label} Git ref to use for a git resource in the release. Format: StepName:GitRef or StepName:GitResourceName:GitRef. If the GitResourceName is omitted, it's assumed to be the primary git resource for the step. The GitRef can be replaced with an asterisk. An asterisk will use the tip ref of the step-defined default branch. - **`IgnoreChannelRules`** :span[boolean]{.type-label} @@ -1229,9 +1211,7 @@ Also reachable at `/api/releases/{id}`, `/api/spaces/{spaceIdentifier}/releases/ "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -1436,9 +1416,7 @@ Also reachable at `/api/releases/{id}`, `/api/spaces/{spaceIdentifier}/releases/ "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -1549,9 +1527,7 @@ Also reachable at `/api/releases/{id}/deployments/template`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -1570,9 +1546,7 @@ Also reachable at `/api/releases/{id}/deployments/template`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -1603,7 +1577,8 @@ Also reachable at `/api/releases/{releaseId}/defects`, `/api/spaces/{spaceIdenti - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} Minimum length 1. @@ -1632,7 +1607,7 @@ Also reachable at `/api/releases/{releaseId}/defects`, `/api/spaces/{spaceIdenti ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Defect", "Items": [ { "Description": "string", @@ -1640,24 +1615,20 @@ Also reachable at `/api/releases/{releaseId}/defects`, `/api/spaces/{spaceIdenti "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Status": "Unresolved" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1721,9 +1692,7 @@ Also reachable at `/api/releases/{releaseId}/defects`, `/api/spaces/{spaceIdenti "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Status": "Unresolved" } @@ -1768,9 +1737,7 @@ Also reachable at `/api/releases/{releaseId}/defects/resolve`, `/api/spaces/{spa "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Status": "Unresolved" } @@ -1805,7 +1772,8 @@ Deployments will be ordered from most recent to least recent. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Changes`** :span[array of object]{.type-label} @@ -1873,7 +1841,7 @@ Deployments will be ordered from most recent to least recent. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Deployment", "Items": [ { "ChangeRequestSettings": [ @@ -1918,9 +1886,7 @@ Deployments will be ordered from most recent to least recent. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1950,17 +1916,15 @@ Deployments will be ordered from most recent to least recent. "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2065,9 +2029,7 @@ Also reachable at `/api/releases/{releaseId}/deployments/preview/{environmentId} "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -2219,9 +2181,7 @@ Also reachable at `/api/releases/{releaseId}/deployments/previews`, `/api/spaces "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -2338,9 +2298,7 @@ Also reachable at `/api/releases/{releaseId}/progression`, `/api/spaces/{spaceId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextDeployments": [ "Environments-1", @@ -2503,9 +2461,7 @@ Only the release notes are changed and everything else about the Release is left "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", @@ -2665,9 +2621,7 @@ Also reachable at `/api/releases/{releaseId}/snapshot-variables`, `/api/spaces/{ "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectDeploymentProcessSnapshotId": "string", "ProjectId": "Projects-1", diff --git a/src/pages/docs/api/_generated/retention.md b/src/pages/docs/api/_generated/retention.md index fa06d8664e..56548bef91 100644 --- a/src/pages/docs/api/_generated/retention.md +++ b/src/pages/docs/api/_generated/retention.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Retention --- @@ -30,9 +30,7 @@ title: Retention "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "RetentionDays": 0 } diff --git a/src/pages/docs/api/_generated/runbook-processes.md b/src/pages/docs/api/_generated/runbook-processes.md index 178433c2eb..368c71e7f1 100644 --- a/src/pages/docs/api/_generated/runbook-processes.md +++ b/src/pages/docs/api/_generated/runbook-processes.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-20 +modDate: 2026-09-04 title: Runbook Processes --- @@ -30,7 +30,8 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses`, `/api/spaces/{sp - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -61,7 +62,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses`, `/api/spaces/{sp ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookProcess", "Items": [ { "Id": "string", @@ -69,9 +70,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses`, `/api/spaces/{sp "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -82,17 +81,15 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses`, `/api/spaces/{sp "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -151,9 +148,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses/{id}`, `/api/space "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -236,9 +231,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -308,9 +301,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -423,9 +414,7 @@ Also reachable at `/api/projects/{projectId}/runbookProcesses/{id}/runbookSnapsh "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextNameIncrement": "string", "Packages": [ @@ -508,9 +497,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbookProcesses/{id}`, `/ "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -601,9 +588,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -673,9 +658,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -727,7 +710,8 @@ Also reachable at `/api/runbookProcesses`, `/api/spaces/{spaceIdentifier}/runboo - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. @@ -758,7 +742,7 @@ Also reachable at `/api/runbookProcesses`, `/api/spaces/{spaceIdentifier}/runboo ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookProcess", "Items": [ { "Id": "string", @@ -766,9 +750,7 @@ Also reachable at `/api/runbookProcesses`, `/api/spaces/{spaceIdentifier}/runboo "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -779,17 +761,15 @@ Also reachable at `/api/runbookProcesses`, `/api/spaces/{spaceIdentifier}/runboo "Version": 0 } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -847,9 +827,7 @@ Also reachable at `/api/runbookProcesses/{id}`, `/api/spaces/{spaceIdentifier}/r "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -931,9 +909,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -1003,9 +979,7 @@ Only allowed for Runbook Processes owned by a project. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastSnapshotId": "string", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectId": "Projects-1", "RunbookId": "string", @@ -1121,9 +1095,7 @@ Also reachable at `/api/runbookProcesses/{id}/runbookSnapshotTemplate`, `/api/sp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextNameIncrement": "string", "Packages": [ diff --git a/src/pages/docs/api/_generated/runbook-runs.md b/src/pages/docs/api/_generated/runbook-runs.md index 8fdd26ea93..49b4baebdc 100644 --- a/src/pages/docs/api/_generated/runbook-runs.md +++ b/src/pages/docs/api/_generated/runbook-runs.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Runbook Runs --- @@ -47,7 +47,8 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Comments`** :span[string]{.type-label} @@ -115,7 +116,7 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookRun", "Items": [ { "ChangeRequestSettings": [ @@ -154,9 +155,7 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -188,17 +187,15 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -396,9 +393,7 @@ Also reachable at `/api/projects/{projectId}/runbookRuns`, `/api/spaces/{spaceId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -555,9 +550,7 @@ Also reachable at `/api/projects/{projectId}/runbookRuns/{id}`, `/api/spaces/{sp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -721,9 +714,7 @@ Also reachable at `/api/projects/{projectId}/runbookruns/{runbookRunId}/retry/v1 "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -974,9 +965,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{runbookId}/run/v "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1178,7 +1167,8 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Comments`** :span[string]{.type-label} @@ -1246,7 +1236,7 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookRun", "Items": [ { "ChangeRequestSettings": [ @@ -1285,9 +1275,7 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1319,17 +1307,15 @@ Lists all of the runbookRuns in the supplied Octopus Deploy Space, from projects "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1526,9 +1512,7 @@ Also reachable at `/api/runbookRuns`, `/api/spaces/{spaceIdentifier}/runbookRuns "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -1688,9 +1672,7 @@ Also reachable at `/api/runbookRuns/{id}`, `/api/spaces/{spaceIdentifier}/runboo "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", diff --git a/src/pages/docs/api/_generated/runbook-snapshots.md b/src/pages/docs/api/_generated/runbook-snapshots.md index 9ac2d52420..5259db826c 100644 --- a/src/pages/docs/api/_generated/runbook-snapshots.md +++ b/src/pages/docs/api/_generated/runbook-snapshots.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Runbook Snapshots --- @@ -125,7 +125,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -171,7 +172,7 @@ Runbook Snapshots will be ordered from most recent to least recent. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookSnapshot", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -189,9 +190,7 @@ Runbook Snapshots will be ordered from most recent to least recent. "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -208,17 +207,15 @@ Runbook Snapshots will be ordered from most recent to least recent. "VariableSnapshotConcurrencyToken": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -356,9 +353,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots`, `/api/spaces/{sp "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -467,9 +462,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{idOrName}`, `/api "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -633,9 +626,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}`, `/api/space "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -691,7 +682,8 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns`, - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Comments`** :span[string]{.type-label} @@ -759,7 +751,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns`, ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookRun", "Items": [ { "ChangeRequestSettings": [ @@ -798,9 +790,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns`, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -832,17 +822,15 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}/runbookRuns`, "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -926,9 +914,7 @@ Gets a document that describes what steps will/won't be run during a run to a gi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -1023,9 +1009,7 @@ Gets all of the information necessary for creating or editing a run for this sna "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -1044,9 +1028,7 @@ Gets all of the information necessary for creating or editing a run for this sna "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -1159,9 +1141,7 @@ Update the variable snapshots associated with the runbook snapshot to the latest "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -1284,9 +1264,7 @@ Update the variable snapshots associated with the runbook snapshot to the latest "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -1379,9 +1357,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{id}/variables`, ` "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1536,9 +1512,7 @@ Also reachable at `/api/projects/{projectId}/runbookSnapshots/{runbookSnapshotId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -1606,7 +1580,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -1652,7 +1627,7 @@ Runbook Snapshots will be ordered from most recent to least recent. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookSnapshot", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -1670,9 +1645,7 @@ Runbook Snapshots will be ordered from most recent to least recent. "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -1689,17 +1662,15 @@ Runbook Snapshots will be ordered from most recent to least recent. "VariableSnapshotConcurrencyToken": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1750,7 +1721,8 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -1796,7 +1768,7 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookSnapshot", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -1814,9 +1786,7 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -1833,17 +1803,15 @@ Gets a paginated list of the runbook snapshots in the supplied Octopus Deploy Sp "VariableSnapshotConcurrencyToken": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1979,9 +1947,7 @@ Also reachable at `/api/runbookSnapshots`, `/api/spaces/{spaceIdentifier}/runboo "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -2088,9 +2054,7 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -2252,9 +2216,7 @@ Also reachable at `/api/runbookSnapshots/{id}`, `/api/spaces/{spaceIdentifier}/r "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -2309,7 +2271,8 @@ Also reachable at `/api/runbookSnapshots/{id}/runbookRuns`, `/api/spaces/{spaceI - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ChangeRequestSettings`** :span[array of object]{.type-label} - **`Comments`** :span[string]{.type-label} @@ -2377,7 +2340,7 @@ Also reachable at `/api/runbookSnapshots/{id}/runbookRuns`, `/api/spaces/{spaceI ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookRun", "Items": [ { "ChangeRequestSettings": [ @@ -2416,9 +2379,7 @@ Also reachable at `/api/runbookSnapshots/{id}/runbookRuns`, `/api/spaces/{spaceI "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ManifestVariableSetId": "string", "Name": "string", @@ -2450,17 +2411,15 @@ Also reachable at `/api/runbookSnapshots/{id}/runbookRuns`, `/api/spaces/{spaceI "UseGuidedFailure": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2544,9 +2503,7 @@ Gets a document that describes what steps will/won't be run during a run to a gi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -2644,9 +2601,7 @@ Gets all of the information necessary for creating or editing a run for this sna "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -2665,9 +2620,7 @@ Gets all of the information necessary for creating or editing a run for this sna "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -2778,9 +2731,7 @@ Update the variable snapshots associated with the runbook snapshot to the latest "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -2843,7 +2794,8 @@ Runbook Snapshots will be ordered from most recent to least recent. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Assembled`** :span[string]{.type-label} Format `date-time`. @@ -2889,7 +2841,7 @@ Runbook Snapshots will be ordered from most recent to least recent. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "RunbookSnapshot", "Items": [ { "Assembled": "2020-01-01T00:00:00.000Z", @@ -2907,9 +2859,7 @@ Runbook Snapshots will be ordered from most recent to least recent. "string" ], "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Notes": "string", @@ -2926,17 +2876,15 @@ Runbook Snapshots will be ordered from most recent to least recent. "VariableSnapshotConcurrencyToken": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/runbooks.md b/src/pages/docs/api/_generated/runbooks.md index 44c2383110..315c322a6c 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-03 +modDate: 2026-09-04 title: Runbooks --- @@ -80,7 +80,8 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CancelQueuedTasks`** :span[boolean]{.type-label} - **`CancelRunningTasks`** :span[boolean]{.type-label} @@ -127,7 +128,7 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Runbook", "Items": [ { "CancelQueuedTasks": false, @@ -153,9 +154,7 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -175,17 +174,15 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -243,7 +240,7 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent - **`RunbookProcessId`** :span[string]{.type-label} Leave unset. Octopus creates an empty runbook process for the new runbook and links it automatically. - **`RunbookTags`** :span[array of string]{.type-label} - Tags to apply to the runbook, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). Call find_tag_sets to discover which tag sets apply to runbooks and what tags they contain. + Tags to apply to the runbook, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). Find the tag sets first to discover which ones apply to runbooks and what tags they contain. - **`Slug`** :span[string]{.type-label} A short URL-friendly identifier for the runbook, unique within the project. Generated from the name when omitted. - **`SpaceId`** :span[string]{.type-label} *(required)* @@ -360,9 +357,7 @@ Also reachable at `/api/projects/{projectId}/runbooks`, `/api/spaces/{spaceIdent "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -466,9 +461,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/all/v2`, `/api/spaces/{spa "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -676,9 +669,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -757,9 +748,9 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}`, `/api/spaces/{space - **`Unit`** :span[enum]{.type-label} Allowed values: `Days`, `Items`. - **`RunbookProcessId`** :span[string]{.type-label} - Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process. + Leave this as the value returned when fetching the runbook. Octopus manages the link between a runbook and its process. - **`RunbookTags`** :span[array of string]{.type-label} - The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks. + The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Find the tag sets first to discover which ones apply to runbooks. - **`Slug`** :span[string]{.type-label} A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted. - **`SpaceId`** :span[string]{.type-label} *(required)* @@ -878,9 +869,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}`, `/api/spaces/{space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -983,9 +972,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}/environments`, `/api/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1107,9 +1094,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}/runbookRunTemplate`, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -1128,9 +1113,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{id}/runbookRunTemplate`, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -1221,9 +1204,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -1337,9 +1318,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -1604,9 +1583,7 @@ Gets a list of Runbook Run Previews that describes what steps will/won't be run "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -1725,9 +1702,7 @@ Also reachable at `/api/projects/{projectId}/runbooks/{runbookId}/runbookSnapsho "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextNameIncrement": "string", "Packages": [ @@ -1787,7 +1762,8 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks`, `/api/spaces/{s - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CancelQueuedTasks`** :span[boolean]{.type-label} - **`CancelRunningTasks`** :span[boolean]{.type-label} @@ -1834,7 +1810,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks`, `/api/spaces/{s ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Runbook", "Items": [ { "CancelQueuedTasks": false, @@ -1860,9 +1836,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks`, `/api/spaces/{s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -1882,17 +1856,15 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks`, `/api/spaces/{s "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -2090,9 +2062,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}`, `/api/spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -2123,7 +2093,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}`, `/api/spac **Path Parameters** - **`gitRef`** :span[string]{.type-label} *(required)* - The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches. + The Git branch where the runbook is stored. - **`id`** :span[string]{.type-label} *(required)* The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref. - **`projectId`** :span[string]{.type-label} *(required)* @@ -2158,7 +2128,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}`, `/api/spac - **`ForcePackageDownload`** :span[boolean]{.type-label} Re-download every package on each run instead of reusing the copy already cached on the deployment target. Resets to false when omitted. - **`GitRef`** :span[string]{.type-label} *(required)* - The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Use get_branches to list the project's branches. + The Git branch to commit the change to. This must be a branch — a tag or commit cannot be written to — and the branch must not be protected in the project's version control settings. Find the project's branches first to see the valid values. - **`Id`** :span[string]{.type-label} *(required)* The ID of the runbook to update. A runbook stored in Git uses its slug as the ID, which is only unique within its project and Git ref. - **`MultiTenancyMode`** :span[enum]{.type-label} @@ -2177,9 +2147,9 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}`, `/api/spac - **`Unit`** :span[enum]{.type-label} Allowed values: `Days`, `Items`. - **`RunbookProcessId`** :span[string]{.type-label} - Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process. + Leave this as the value returned when fetching the runbook. Octopus manages the link between a runbook and its process. - **`RunbookTags`** :span[array of string]{.type-label} - The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks. + The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Find the tag sets first to discover which ones apply to runbooks. - **`Slug`** :span[string]{.type-label} A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted. - **`SpaceId`** :span[string]{.type-label} *(required)* @@ -2300,9 +2270,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}`, `/api/spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -2436,9 +2404,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}/environments "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -2563,9 +2529,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRunTe "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -2584,9 +2548,7 @@ Also reachable at `/api/projects/{projectId}/{gitRef}/runbooks/{id}/runbookRunTe "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -2678,9 +2640,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -2796,9 +2756,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -2935,9 +2893,7 @@ Gets a list of Runbook Run Previews that describes what steps will/won't be run "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -3057,9 +3013,7 @@ Also reachable at `/api/projects/{projectId}/{gitref}/runbooks/{runbookId}/runbo "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextNameIncrement": "string", "Packages": [ @@ -3115,7 +3069,8 @@ Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sort - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CancelQueuedTasks`** :span[boolean]{.type-label} - **`CancelRunningTasks`** :span[boolean]{.type-label} @@ -3162,7 +3117,7 @@ Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sort ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Runbook", "Items": [ { "CancelQueuedTasks": false, @@ -3188,9 +3143,7 @@ Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sort "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -3210,17 +3163,15 @@ Gets a paginated list of the Runbooks in the supplied Octopus Deploy Space (sort "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -3276,7 +3227,7 @@ Also reachable at `/api/runbooks`, `/api/spaces/{spaceIdentifier}/runbooks`. - **`RunbookProcessId`** :span[string]{.type-label} Leave unset. Octopus creates an empty runbook process for the new runbook and links it automatically. - **`RunbookTags`** :span[array of string]{.type-label} - Tags to apply to the runbook, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). Call find_tag_sets to discover which tag sets apply to runbooks and what tags they contain. + Tags to apply to the runbook, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). Find the tag sets first to discover which ones apply to runbooks and what tags they contain. - **`Slug`** :span[string]{.type-label} A short URL-friendly identifier for the runbook, unique within the project. Generated from the name when omitted. - **`SpaceId`** :span[string]{.type-label} *(required)* @@ -3393,9 +3344,7 @@ Also reachable at `/api/runbooks`, `/api/spaces/{spaceIdentifier}/runbooks`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -3509,9 +3458,7 @@ Lists all of the Runbooks in the supplied Space. The results will be sorted alph "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -3621,9 +3568,7 @@ Also reachable at `/api/runbooks/{id}`, `/api/spaces/{spaceIdentifier}/runbooks/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -3700,9 +3645,9 @@ Also reachable at `/api/runbooks/{id}`, `/api/spaces/{spaceIdentifier}/runbooks/ - **`Unit`** :span[enum]{.type-label} Allowed values: `Days`, `Items`. - **`RunbookProcessId`** :span[string]{.type-label} - Leave this as the value returned by get_runbook. Octopus manages the link between a runbook and its process. + Leave this as the value returned when fetching the runbook. Octopus manages the link between a runbook and its process. - **`RunbookTags`** :span[array of string]{.type-label} - The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Call find_tag_sets to discover which tag sets apply to runbooks. + The runbook's complete set of tags, each written as "TagSet/Tag" using either the names or the IDs of the tag set and tag (for example "Ops/Nightly"). This replaces the current tags, so resubmit the existing ones you want to keep. Find the tag sets first to discover which ones apply to runbooks. - **`Slug`** :span[string]{.type-label} A short URL-friendly identifier for the runbook, unique within the project. The current slug is kept when omitted. - **`SpaceId`** :span[string]{.type-label} *(required)* @@ -3821,9 +3766,7 @@ Also reachable at `/api/runbooks/{id}`, `/api/spaces/{spaceIdentifier}/runbooks/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MultiTenancyMode": "Untenanted", "Name": "string", @@ -3928,9 +3871,7 @@ Also reachable at `/api/runbooks/{id}/environments`, `/api/spaces/{spaceIdentifi "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -4003,9 +3944,7 @@ Also reachable at `/api/runbooks/{id}/runbookRunTemplate`, `/api/spaces/{spaceId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PromoteTo": [ { @@ -4024,9 +3963,7 @@ Also reachable at `/api/runbooks/{id}/runbookRunTemplate`, `/api/spaces/{spaceId "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PromoteTo": [ @@ -4117,9 +4054,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -4233,9 +4168,7 @@ Gets a Runbook Run Preview that describes what steps will/won't be run during a "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "StepsToExecute": [ { @@ -4485,9 +4418,7 @@ Also reachable at `/api/runbooks/{runbookId}/runbookSnapshotTemplate`, `/api/spa "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NextNameIncrement": "string", "Packages": [ diff --git a/src/pages/docs/api/_generated/scheduled-jobs.md b/src/pages/docs/api/_generated/scheduled-jobs.md index d91f07ac46..5278162690 100644 --- a/src/pages/docs/api/_generated/scheduled-jobs.md +++ b/src/pages/docs/api/_generated/scheduled-jobs.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Scheduled Jobs --- @@ -42,9 +42,7 @@ title: Scheduled Jobs "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "TaskStatus": [ { @@ -53,9 +51,7 @@ title: Scheduled Jobs "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -188,9 +184,7 @@ title: Scheduled Jobs "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` diff --git a/src/pages/docs/api/_generated/scoped-user-roles.md b/src/pages/docs/api/_generated/scoped-user-roles.md index 352af6da6f..7ce7f9e7f6 100644 --- a/src/pages/docs/api/_generated/scoped-user-roles.md +++ b/src/pages/docs/api/_generated/scoped-user-roles.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Scoped User Roles --- @@ -32,7 +32,8 @@ List the name and ID of all of the scoped user roles in the supplied Octopus Dep - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`EnvironmentIds`** :span[array of string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -64,7 +65,7 @@ List the name and ID of all of the scoped user roles in the supplied Octopus Dep ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ScopedUserRole", "Items": [ { "EnvironmentIds": [ @@ -75,9 +76,7 @@ List the name and ID of all of the scoped user roles in the supplied Octopus Dep "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroupIds": [ "string" @@ -95,17 +94,15 @@ List the name and ID of all of the scoped user roles in the supplied Octopus Dep "UserRoleId": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -189,9 +186,7 @@ Also reachable at `/api/scopeduserroles`, `/api/spaces/{spaceIdentifier}/scopedu "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroupIds": [ "string" @@ -254,9 +249,7 @@ Also reachable at `/api/scopeduserroles/{id}`, `/api/spaces/{spaceIdentifier}/sc "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroupIds": [ "string" @@ -360,9 +353,7 @@ Also reachable at `/api/scopeduserroles/{id}`, `/api/spaces/{spaceIdentifier}/sc "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroupIds": [ "string" diff --git a/src/pages/docs/api/_generated/server-status.md b/src/pages/docs/api/_generated/server-status.md index 5822160518..386bdf35b2 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-08-11 +modDate: 2026-09-04 title: Server Status --- @@ -44,9 +44,7 @@ Shows information about the status of the Octopus Server. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MaintenanceExpires": "string", "MaximumAvailableVersion": "string", @@ -179,9 +177,7 @@ Provides a super simple interface perfect for checking the general health of you "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -263,9 +259,7 @@ Provides a super simple interface perfect for checking the general health of you "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MinThreadPoolCount": 0, "OSVersion": "string", @@ -324,9 +318,7 @@ Provides a super simple interface perfect for checking the general health of you "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } diff --git a/src/pages/docs/api/_generated/server.md b/src/pages/docs/api/_generated/server.md index 553f0605b7..c5b8eee3ed 100644 --- a/src/pages/docs/api/_generated/server.md +++ b/src/pages/docs/api/_generated/server.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Server --- @@ -30,9 +30,7 @@ title: Server "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ServerUri": "string" } @@ -76,9 +74,7 @@ title: Server "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ServerUri": "string" } diff --git a/src/pages/docs/api/_generated/signing.md b/src/pages/docs/api/_generated/signing.md index 524d86b569..fc9d24758d 100644 --- a/src/pages/docs/api/_generated/signing.md +++ b/src/pages/docs/api/_generated/signing.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Signing --- @@ -34,9 +34,7 @@ title: Signing "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PublicKeyHostingLocation": "Internal", "RevokeAfterDays": 0 @@ -92,9 +90,7 @@ title: Signing "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PublicKeyHostingLocation": "Internal", "RevokeAfterDays": 0 diff --git a/src/pages/docs/api/_generated/smtp.md b/src/pages/docs/api/_generated/smtp.md index 8d353d032b..f3731a7d86 100644 --- a/src/pages/docs/api/_generated/smtp.md +++ b/src/pages/docs/api/_generated/smtp.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Smtp --- @@ -41,9 +41,7 @@ title: Smtp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SendEmailFrom": "string", "SmtpHost": "string", @@ -115,9 +113,7 @@ title: Smtp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SendEmailFrom": "string", "SmtpHost": "string", @@ -153,9 +149,7 @@ title: Smtp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -189,9 +183,7 @@ title: Smtp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } } @@ -235,9 +227,7 @@ title: Smtp "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SendEmailFrom": "string", "SmtpHost": "string", diff --git a/src/pages/docs/api/_generated/spaces.md b/src/pages/docs/api/_generated/spaces.md index 7d315b052c..b16ed52a8c 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-08-11 +modDate: 2026-09-04 title: Spaces --- @@ -31,7 +31,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials`. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Details`** :span[object]{.type-label} @@ -61,7 +62,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials`. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "GitCredential", "Items": [ { "Description": "string", @@ -72,9 +73,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RepositoryRestrictions": { @@ -86,17 +85,15 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials`. "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -198,7 +195,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v1`. - **`GitCredentials`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -216,7 +214,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v1`. { "GitCredentials": { "Id": "string", - "ItemType": "string", + "ItemType": "GitCredential", "Items": [ { "Description": "string", @@ -224,23 +222,23 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v1`. "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "RepositoryRestrictions": {}, "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` @@ -340,7 +338,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`. `200` — Success -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} - **`Details`** :span[object]{.type-label} @@ -360,7 +359,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`. :::api-example{label="Response"} ```json { - "ItemType": "string", + "ItemType": "GitCredentialV2", "Items": [ { "Description": "string", @@ -380,10 +379,10 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/v2`. "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -492,9 +491,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RepositoryRestrictions": { @@ -722,9 +719,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/git-credentials/{id}/v1`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "RepositoryRestrictions": { @@ -983,9 +978,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/git/refs`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string" } @@ -1020,7 +1013,8 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + 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} @@ -1055,7 +1049,7 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Space", "Items": [ { "Description": "string", @@ -1072,9 +1066,7 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1088,17 +1080,15 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b "TaskQueueStopped": false } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1187,9 +1177,7 @@ Lists all of the Spaces in the supplied Octopus Deploy Space. The results will b "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1266,9 +1254,7 @@ Lists all Spaces. The results will be sorted alphabetically by name. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1365,9 +1351,7 @@ Lists all Spaces. The results will be sorted alphabetically by name. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1442,9 +1426,7 @@ Lists all Spaces. The results will be sorted alphabetically by name. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1550,9 +1532,7 @@ Lists all Spaces. The results will be sorted alphabetically by name. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -1759,9 +1739,7 @@ Also reachable at `/api/spaces/{id}/search`, `/api/spaces/{spaceIdentifier}/spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", diff --git a/src/pages/docs/api/_generated/subscriptions.md b/src/pages/docs/api/_generated/subscriptions.md index e5d57d8f16..3e25262a5c 100644 --- a/src/pages/docs/api/_generated/subscriptions.md +++ b/src/pages/docs/api/_generated/subscriptions.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Subscriptions --- @@ -34,7 +34,8 @@ Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`EventNotificationSubscription`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} @@ -65,7 +66,7 @@ Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Subscription", "Items": [ { "EventNotificationSubscription": { @@ -102,26 +103,22 @@ Lists all of the Subscriptions in the supplied Octopus Deploy Space. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", "Type": "Event" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -375,9 +372,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/subscriptions`, `/api/subscript "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -519,9 +514,7 @@ Lists all the Subscriptions in the supplied Octopus Deploy Space "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -667,9 +660,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/subscriptions/{id}`, `/api/subs "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", @@ -935,9 +926,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/subscriptions/{id}`, `/api/subs "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpaceId": "Spaces-1", diff --git a/src/pages/docs/api/_generated/tag-sets.md b/src/pages/docs/api/_generated/tag-sets.md index 1ff4659b21..c906e81f94 100644 --- a/src/pages/docs/api/_generated/tag-sets.md +++ b/src/pages/docs/api/_generated/tag-sets.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Tag Sets --- @@ -40,7 +40,8 @@ Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Description`** :span[string]{.type-label} Gets or sets the description of this tag set. @@ -80,7 +81,7 @@ Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will ```json { "Id": "string", - "ItemType": "string", + "ItemType": "TagSet", "Items": [ { "Description": "string", @@ -89,9 +90,7 @@ Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Scopes": [ @@ -105,17 +104,15 @@ Lists all of the Tag Sets in the supplied Octopus Deploy Space. The results will "Type": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -228,9 +225,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tagsets`, `/api/tagsets`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Scopes": [ @@ -317,9 +312,7 @@ Lists the details of all of the Tag Sets in the supplied Octopus Deploy Space. T "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Scopes": [ @@ -430,9 +423,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tagsets/{id}`, `/api/tagsets/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Scopes": [ @@ -481,7 +472,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tagsets/{id}`, `/api/tagsets/{i Sets the sort order of this tag set. - **`SpaceId`** :span[string]{.type-label} *(required)* - **`Tags`** :span[array of object]{.type-label} - The complete list of tags for the tag set; existing tags omitted here are deleted (rejected if still in use). Each tag is an object with a 'Name', an optional 'Description', a 'Color' hex code (e.g. '#3156B3'), a 'SortOrder', and — for existing tags — the 'Id' from get_tag_set, which must be kept to update or rename a tag rather than replace it. + The complete list of tags for the tag set; existing tags omitted here are deleted (rejected if still in use). Each tag is an object with a 'Name', an optional 'Description', a 'Color' hex code (e.g. '#3156B3'), a 'SortOrder', and — for existing tags — the 'Id' from the existing tag set, which must be kept to update or rename a tag rather than replace it. - **`CanonicalTagName`** :span[string]{.type-label} This is the canonical name for the Tag formed as {TagSetName}/{TagName} which is easier to work with than the ID in certain scenarios. - **`Color`** :span[string]{.type-label} @@ -568,9 +559,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tagsets/{id}`, `/api/tagsets/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Scopes": [ diff --git a/src/pages/docs/api/_generated/tasks.md b/src/pages/docs/api/_generated/tasks.md index d02ec4e6ee..e003b06e64 100644 --- a/src/pages/docs/api/_generated/tasks.md +++ b/src/pages/docs/api/_generated/tasks.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Tasks --- @@ -70,7 +70,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks`, `/api/tasks`. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Arguments`** :span[object]{.type-label} Gets or sets any arguments to the task. @@ -145,7 +146,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks`, `/api/tasks`. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Task", "Items": [ { "Arguments": { @@ -171,9 +172,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks`, `/api/tasks`. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -191,17 +190,15 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks`, `/api/tasks`. "State": "Queued" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -336,9 +333,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks`, `/api/tasks`. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -462,9 +457,7 @@ Note that deployment tasks cannot be re-run. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -620,9 +613,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}`, `/api/tasks/{id}`. "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -744,9 +735,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/cancel`, `/api/tasks "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -900,9 +889,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/details`, `/api/task "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "PhysicalLogSize": 0, "Progress": { @@ -933,9 +920,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/details`, `/api/task "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -996,7 +981,8 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/queued-behind`, `/ap - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Arguments`** :span[object]{.type-label} Gets or sets any arguments to the task. @@ -1071,7 +1057,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/queued-behind`, `/ap ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Task", "Items": [ { "Arguments": { @@ -1097,9 +1083,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/queued-behind`, `/ap "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -1117,17 +1101,15 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/queued-behind`, `/ap "State": "Queued" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -1282,9 +1264,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/state`, `/api/tasks/ "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -1344,9 +1324,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tasks/{id}/status/messages`, `/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Message": "string", "Title": "string" diff --git a/src/pages/docs/api/_generated/teams.md b/src/pages/docs/api/_generated/teams.md index 102d3c5b08..d920a64ccb 100644 --- a/src/pages/docs/api/_generated/teams.md +++ b/src/pages/docs/api/_generated/teams.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Teams --- @@ -37,7 +37,8 @@ Lists all of the Teams in the system or Octopus Deploy Space (if provided). The - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanBeDeleted`** :span[boolean]{.type-label} Gets or sets a flag indicating whether the team can be deleted. The built-in teams provided by Octopus generally cannot be deleted. @@ -79,7 +80,7 @@ Lists all of the Teams in the system or Octopus Deploy Space (if provided). The ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Team", "Items": [ { "CanBeDeleted": false, @@ -94,9 +95,7 @@ Lists all of the Teams in the system or Octopus Deploy Space (if provided). The "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MemberUserIds": [ "Users-1", @@ -107,17 +106,15 @@ Lists all of the Teams in the system or Octopus Deploy Space (if provided). The "SpaceId": "Spaces-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -225,9 +222,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/teams`, `/api/teams`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MemberUserIds": [ "Users-1", @@ -305,9 +300,7 @@ Lists all of the Teams in the supplied Octopus Deploy Space. The results will be "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MemberUserIds": [ "Users-1", @@ -386,9 +379,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/teams/{id}`, `/api/teams/{id}`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MemberUserIds": [ "Users-1", @@ -507,9 +498,7 @@ The Everyone Team is treated as a special case and its members and external grou "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MemberUserIds": [ "Users-1", @@ -564,7 +553,8 @@ List all the Scoped User Roles for the Team. Results will be sorted by Space Id - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`EnvironmentIds`** :span[array of string]{.type-label} - **`Id`** :span[string]{.type-label} @@ -596,7 +586,7 @@ List all the Scoped User Roles for the Team. Results will be sorted by Space Id ```json { "Id": "string", - "ItemType": "string", + "ItemType": "ScopedUserRole", "Items": [ { "EnvironmentIds": [ @@ -607,9 +597,7 @@ List all the Scoped User Roles for the Team. Results will be sorted by Space Id "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectGroupIds": [ "string" @@ -627,17 +615,15 @@ List all the Scoped User Roles for the Team. Results will be sorted by Space Id "UserRoleId": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/telemetry.md b/src/pages/docs/api/_generated/telemetry.md index 00570b8d90..795d53cdc3 100644 --- a/src/pages/docs/api/_generated/telemetry.md +++ b/src/pages/docs/api/_generated/telemetry.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Telemetry --- @@ -112,9 +112,7 @@ title: Telemetry "LastModifiedOn": "2020-01-01T00:00:00.000Z", "LastUpdatedTime": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "PendingInterruptionTypes": [ @@ -164,9 +162,7 @@ title: Telemetry "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ShowAsNewUntil": "2020-01-01T00:00:00.000Z" } @@ -201,9 +197,7 @@ title: Telemetry "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ShowAsNewUntil": "2020-01-01T00:00:00.000Z" } @@ -236,9 +230,7 @@ title: Telemetry "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ShowAsNewUntil": "2020-01-01T00:00:00.000Z" } diff --git a/src/pages/docs/api/_generated/tenants.md b/src/pages/docs/api/_generated/tenants.md index d2a4072981..a7b3521905 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-08-11 +modDate: 2026-09-04 title: Tenants --- @@ -45,7 +45,8 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ClonedFromTenantId`** :span[string]{.type-label} - **`CustomFields`** :span[array of string]{.type-label} @@ -81,7 +82,7 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Tenant", "Items": [ { "ClonedFromTenantId": "string", @@ -98,9 +99,7 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -121,17 +120,15 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -236,9 +233,7 @@ Creates a new Tenant, optionally cloning an existing tenant if the clone query s "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -335,9 +330,7 @@ Lists all of the tenants in the supplied Octopus Deploy Space. The results will "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -395,9 +388,7 @@ If multi-tenancy is enabled, \"Enabled\" will be true, otherwise it will be fals "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } } ``` @@ -573,9 +564,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}`, `/api/tenants/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -698,9 +687,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}`, `/api/tenants/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "ProjectEnvironments": { @@ -900,9 +887,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}/variables`, `/api/ } }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectVariables": { "additionalProp1": { @@ -1183,9 +1168,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}/variables`, `/api/ } }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectVariables": { "additionalProp1": { @@ -1464,9 +1447,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenants/{id}/variables`, `/api/ } }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectVariables": { "additionalProp1": { @@ -1748,9 +1729,7 @@ Also reachable at `/api/tenants/{id}/variables`. } }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectVariables": { "additionalProp1": { @@ -2747,9 +2726,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/tenantvariables/all`, `/api/ten } }, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "ProjectVariables": { "additionalProp1": { diff --git a/src/pages/docs/api/_generated/upgrade.md b/src/pages/docs/api/_generated/upgrade.md index dc00def7bb..03b7a1550d 100644 --- a/src/pages/docs/api/_generated/upgrade.md +++ b/src/pages/docs/api/_generated/upgrade.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Upgrade --- @@ -38,9 +38,7 @@ title: Upgrade "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NotificationMode": "AlwaysShow" } @@ -100,9 +98,7 @@ title: Upgrade "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "NotificationMode": "AlwaysShow" } diff --git a/src/pages/docs/api/_generated/user-permissions.md b/src/pages/docs/api/_generated/user-permissions.md index ee5282dd75..aab7e2b8df 100644 --- a/src/pages/docs/api/_generated/user-permissions.md +++ b/src/pages/docs/api/_generated/user-permissions.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-25 +modDate: 2026-09-04 title: User Permissions --- @@ -200,9 +200,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/users/{id}/permissions`, `/api/ "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SpacePermissions": { "AccountCreate": [ @@ -3203,9 +3201,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/users/{id}/permissions/configur "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "SpacePermissions": { "AccountCreate": [ diff --git a/src/pages/docs/api/_generated/user-roles.md b/src/pages/docs/api/_generated/user-roles.md index c39226e233..e372fec95d 100644 --- a/src/pages/docs/api/_generated/user-roles.md +++ b/src/pages/docs/api/_generated/user-roles.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: User Roles --- @@ -28,7 +28,8 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanBeDeleted`** :span[boolean]{.type-label} - **`Description`** :span[string]{.type-label} @@ -63,7 +64,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results ```json { "Id": "string", - "ItemType": "string", + "ItemType": "UserRole", "Items": [ { "CanBeDeleted": false, @@ -78,9 +79,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpacePermissionDescriptions": [ @@ -94,17 +93,15 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -176,9 +173,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpacePermissionDescriptions": [ @@ -239,9 +234,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpacePermissionDescriptions": [ @@ -305,9 +298,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpacePermissionDescriptions": [ @@ -397,9 +388,7 @@ Lists all of the User Roles in the current Octopus Deploy instance. The results "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "SpacePermissionDescriptions": [ diff --git a/src/pages/docs/api/_generated/users.md b/src/pages/docs/api/_generated/users.md index c1e6a24ba0..4aa52ff750 100644 --- a/src/pages/docs/api/_generated/users.md +++ b/src/pages/docs/api/_generated/users.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Users --- @@ -33,7 +33,8 @@ Lists all of the Users in the current Octopus Deploy instance, from all Teams. T - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanPasswordBeEdited`** :span[boolean]{.type-label} - **`Created`** :span[string]{.type-label} @@ -75,7 +76,7 @@ Lists all of the Users in the current Octopus Deploy instance, from all Teams. T ```json { "Id": "string", - "ItemType": "string", + "ItemType": "User", "Items": [ { "CanPasswordBeEdited": false, @@ -92,26 +93,22 @@ Lists all of the Users in the current Octopus Deploy instance, from all Teams. T "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", "Username": "string" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -216,9 +213,7 @@ Lists all of the Users in the current Octopus Deploy instance, from all Teams. T "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -286,9 +281,7 @@ Lists all the Users in the System. The results will be sorted alphabetically by "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -523,9 +516,7 @@ Also reachable at `/api/users/authentication`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -604,9 +595,7 @@ Logs out the current user. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -714,9 +703,7 @@ Unless the first administrator user is being registered, an invitation code must "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -790,9 +777,7 @@ Unless the first administrator user is being registered, an invitation code must "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", @@ -902,9 +887,7 @@ Unless the first administrator user is being registered, an invitation code must "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Password": "string", "ServiceAccountType": "Standard", diff --git a/src/pages/docs/api/_generated/variables.md b/src/pages/docs/api/_generated/variables.md index e224d4afab..9eb5320b36 100644 --- a/src/pages/docs/api/_generated/variables.md +++ b/src/pages/docs/api/_generated/variables.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Variables --- @@ -139,9 +139,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/variables` "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -571,9 +569,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/{gitRef}/v "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1011,9 +1007,7 @@ Lists all the Variable Sets in the supplied Space. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1189,9 +1183,7 @@ Lists the evaluated Variables for a deployment. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1409,9 +1401,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/variables/{id}`, `/api/variable "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1626,9 +1616,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/variables/{id}`, `/api/variable "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { @@ -1833,9 +1821,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/variables/{id}`, `/api/variable "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "OwnerId": "string", "ScopeValues": { diff --git a/src/pages/docs/api/_generated/worker-pools.md b/src/pages/docs/api/_generated/worker-pools.md index e651b69ae7..8f0703f0a9 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-08-11 +modDate: 2026-09-04 title: Worker Pools --- @@ -37,7 +37,8 @@ Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Spac - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`CanAddWorkers`** :span[boolean]{.type-label} - **`Description`** :span[string]{.type-label} @@ -75,7 +76,7 @@ Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Spac ```json { "Id": "string", - "ItemType": "string", + "ItemType": "WorkerPool", "Items": [ { "CanAddWorkers": false, @@ -85,9 +86,7 @@ Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -96,17 +95,15 @@ Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Spac "WorkerPoolType": "StaticWorkerPool" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -188,9 +185,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workerpools`, `/api/workerpools "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -256,9 +251,7 @@ Lists the name and ID of of the Worker Pools in the supplied Octopus Deploy Spac "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -448,7 +441,9 @@ Lists all worker pools, including a summary of machine information. "IsDefault": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "Name": "string", "Slug": "string", "SortOrder": 0, @@ -545,9 +540,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workerpools/{id}`, `/api/worker "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -640,9 +633,7 @@ Updates an existing worker pool. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Name": "string", "Slug": "string", @@ -703,7 +694,8 @@ Lists all of the machines that belong to the given worker pool. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -748,7 +740,7 @@ Lists all of the machines that belong to the given worker pool. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Worker", "Items": [ { "Architecture": "string", @@ -757,7 +749,9 @@ Lists all of the machines that belong to the given worker pool. "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "HasLatestCalamari": false, "HealthStatus": "Healthy", @@ -767,9 +761,7 @@ Lists all of the machines that belong to the given worker pool. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -789,17 +781,15 @@ Lists all of the machines that belong to the given worker pool. ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: diff --git a/src/pages/docs/api/_generated/worker-task-leases.md b/src/pages/docs/api/_generated/worker-task-leases.md index e8a2c71c25..8d965e208c 100644 --- a/src/pages/docs/api/_generated/worker-task-leases.md +++ b/src/pages/docs/api/_generated/worker-task-leases.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-08-11 +modDate: 2026-09-04 title: Worker Task Leases --- @@ -32,7 +32,8 @@ Gets a paginated set of WorkerTaskLeases. - **`WorkerTaskLeases`** :span[object]{.type-label} - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastModifiedBy`** :span[string]{.type-label} @@ -50,7 +51,7 @@ Gets a paginated set of WorkerTaskLeases. { "WorkerTaskLeases": { "Id": "string", - "ItemType": "string", + "ItemType": "WorkerTaskLease", "Items": [ { "Exclusive": false, @@ -63,17 +64,15 @@ Gets a paginated set of WorkerTaskLeases. "WorkerPoolId": "WorkerPools-1" } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } } ``` diff --git a/src/pages/docs/api/_generated/workers.md b/src/pages/docs/api/_generated/workers.md index 5d0001431c..4108ef82db 100644 --- a/src/pages/docs/api/_generated/workers.md +++ b/src/pages/docs/api/_generated/workers.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Api.astro pubDate: 2026-08-11 -modDate: 2026-09-03 +modDate: 2026-09-04 title: Workers --- @@ -49,7 +49,8 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. - **`Id`** :span[string]{.type-label} Gets or sets a unique identifier for this resource. -- **`ItemType`** :span[string]{.type-label} +- **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`Architecture`** :span[string]{.type-label} - **`Endpoint`** :span[object]{.type-label} @@ -94,7 +95,7 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. ```json { "Id": "string", - "ItemType": "string", + "ItemType": "Worker", "Items": [ { "Architecture": "string", @@ -103,7 +104,9 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. "Id": "string", "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {} + "Links": { + "Self": "/api/..." + } }, "HasLatestCalamari": false, "HealthStatus": "Healthy", @@ -113,9 +116,7 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -135,17 +136,15 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. ] } ], - "ItemsPerPage": 0, + "ItemsPerPage": 30, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "LastPageNumber": 0, + "LastPageNumber": 1, "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, - "NumberOfPages": 0, - "TotalResults": 0 + "NumberOfPages": 2, + "TotalResults": 42 } ``` ::: @@ -197,9 +196,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers`, `/api/workers`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "IsDisabled": false, @@ -270,9 +267,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers`, `/api/workers`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -283,9 +278,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers`, `/api/workers`. "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -382,9 +375,7 @@ Lists all of the Workers in the supplied Space. The results will be sorted alpha "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -395,9 +386,7 @@ Lists all of the Workers in the supplied Space. The results will be sorted alpha "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -497,9 +486,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/discover`, `/api/worker "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -510,9 +497,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/discover`, `/api/worker "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -621,7 +606,8 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. - **`WorkerCountPerHealthStatus`** :span[object]{.type-label} - **`Workers`** :span[object]{.type-label} - - **`ItemType`** :span[string]{.type-label} + - **`ItemType`** :span[string]{.type-label} + The type of item in this list. - **`Items`** :span[array of object]{.type-label} - **`ItemsPerPage`** :span[integer]{.type-label} - **`LastPageNumber`** :span[integer]{.type-label} @@ -637,7 +623,7 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. "additionalProp3": 0 }, "Workers": { - "ItemType": "string", + "ItemType": "Worker", "Items": [ { "Architecture": "string", @@ -649,7 +635,9 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. "IsInProcess": false, "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", - "Links": {}, + "Links": { + "Self": "/api/..." + }, "MachinePolicyId": "string", "Name": "string", "OperatingSystem": "string", @@ -668,10 +656,10 @@ List all of the registered worker machines in the supplied Octopus Deploy Space. ] } ], - "ItemsPerPage": 0, - "LastPageNumber": 0, - "NumberOfPages": 0, - "TotalResults": 0 + "ItemsPerPage": 30, + "LastPageNumber": 1, + "NumberOfPages": 2, + "TotalResults": 42 } } ``` @@ -744,9 +732,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}`, `/api/workers/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -757,9 +743,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}`, `/api/workers/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -831,9 +815,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}`, `/api/workers/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "Id": "Machines-1", @@ -904,9 +886,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}`, `/api/workers/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." } }, "HasLatestCalamari": false, @@ -917,9 +897,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}`, `/api/workers/{i "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "MachinePolicyId": "string", "Name": "string", @@ -1006,9 +984,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/workers/{id}/connection`, `/api "LastModifiedBy": "string", "LastModifiedOn": "2020-01-01T00:00:00.000Z", "Links": { - "additionalProp1": "string", - "additionalProp2": "string", - "additionalProp3": "string" + "Self": "/api/..." }, "Logs": [ {