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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions src/pages/docs/api/_generated/action-templates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Action Templates
---

Expand Down Expand Up @@ -660,13 +660,13 @@ Also reachable at `/api/actiontemplates/categories`, `/api/spaces/{spaceIdentifi
```
:::

## List all available action templates including built-in, custom and community contributed step templates
## List all available action templates

:endpoint{method="GET" path="/api/\{spaceId\}/actiontemplates/search"}

Also reachable at `/api/actiontemplates/search`, `/api/spaces/{spaceIdentifier}/actiontemplates/search`.

Lists all of the Action Templates in the supplied Octopus Deploy Space that fit the search criteria.
Lists all the Action Templates in the supplied Octopus Deploy Space that fit the search criteria. Includes built-in, custom and community contributed step templates.

**Path Parameters**

Expand Down Expand Up @@ -1593,12 +1593,14 @@ Also reachable at `/api/actiontemplates/{id}/logo`, `/api/spaces/{spaceIdentifie
```
:::

## Update the logo associated with the latest version of the action template
## Update the action template logo

:endpoint{method="POST" path="/api/\{spaceId\}/actiontemplates/\{id\}/logo"}

Also reachable at `/api/actiontemplates/{id}/logo`, `/api/spaces/{spaceIdentifier}/actiontemplates/{id}/logo`.

Updates the logo associated with the latest version of the action template.

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand All @@ -1616,10 +1618,12 @@ Also reachable at `/api/actiontemplates/{id}/logo`, `/api/spaces/{spaceIdentifie
```
:::

## Update the logo associated with the latest version of the action template
## Update the action template logo

:endpoint{method="PUT" path="/api/\{spaceId\}/actiontemplates/\{id\}/logo"}

Updates the logo associated with the latest version of the action template.

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand All @@ -1637,12 +1641,14 @@ Also reachable at `/api/actiontemplates/{id}/logo`, `/api/spaces/{spaceIdentifie
```
:::

## Update the logo associated with the latest version of the action template
## Update the action template logo

:endpoint{method="PUT" path="/api/spaces/\{spaceIdentifier\}/actiontemplates/\{id\}/logo"}

Also reachable at `/api/actiontemplates/{id}/logo`.

Updates the logo associated with the latest version of the action template.

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand Down
12 changes: 8 additions & 4 deletions src/pages/docs/api/_generated/artifacts.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Artifacts
---

## List all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created
## List artifacts

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

Also reachable at `/api/artifacts`, `/api/spaces/{spaceIdentifier}/artifacts`.

Lists all of the artifacts in the supplied Octopus Deploy Space, from all releases. The results will be sorted by date from most recently to least recently created.

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
Expand Down Expand Up @@ -323,12 +325,14 @@ Also reachable at `/api/artifacts/{id}`, `/api/spaces/{spaceIdentifier}/artifact

`200` — Success

## Get the content associated with an artifact
## Download artifact content

:endpoint{method="GET" path="/api/\{spaceId\}/artifacts/\{id\}/content"}

Also reachable at `/api/artifacts/{id}/content`, `/api/spaces/{spaceIdentifier}/artifacts/{id}/content`.

Get the content associated with an artifact

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand All @@ -346,7 +350,7 @@ Also reachable at `/api/artifacts/{id}/content`, `/api/spaces/{spaceIdentifier}/
```
:::

## PUT /api/{spaceId}/artifacts/{id}/content
## Upload artifact content

:endpoint{method="PUT" path="/api/\{spaceId\}/artifacts/\{id\}/content"}

Expand Down
6 changes: 4 additions & 2 deletions src/pages/docs/api/_generated/authentication.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Authentication
---

Expand Down Expand Up @@ -81,10 +81,12 @@ Provides the details of the enabled authentication providers.
```
:::

## Determine whether an external server (.e.g Okta) has initiated login from a URL query string and, if so, get the provider's name
## Check if an external server has initiated login

:endpoint{method="POST" path="/api/authentication/checklogininitiated"}

Determine whether an external server (.e.g Okta) has initiated login from a URL query string and, if so, get the provider's name

**Request Body**

- **`EncodedQueryString`** :span[string]{.type-label} *(required)*
Expand Down
6 changes: 4 additions & 2 deletions src/pages/docs/api/_generated/build-information.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Build Information
---

## Retrieve a list of build information records describing the vcs information for a given package
## List build information for a package

:endpoint{method="GET" path="/api/\{spaceId\}/build-information"}

Also reachable at `/api/build-information`, `/api/spaces/{spaceIdentifier}/build-information`.

Retrieve a list of build information records describing the vcs information for a given package

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
Expand Down
12 changes: 5 additions & 7 deletions src/pages/docs/api/_generated/certificates.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Certificates
---

Expand Down Expand Up @@ -384,7 +384,7 @@ Adds a new certificate
```
:::

## Get a list of Certificates
## List all Certificates (unpaginated)

:endpoint{method="GET" path="/api/\{spaceId\}/certificates/all"}

Expand Down Expand Up @@ -869,13 +869,13 @@ Also reachable at `/api/certificates/generate`, `/api/spaces/{spaceIdentifier}/c
```
:::

## 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
## List Certificates

:endpoint{method="GET" path="/api/\{spaceId\}/certificates/v2"}

Also reachable at `/api/certificates/v2`, `/api/spaces/{spaceIdentifier}/certificates/v2`.

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**

Expand Down Expand Up @@ -1681,14 +1681,12 @@ Also reachable at `/api/certificates/{id}/unarchive/v1`, `/api/spaces/{spaceIden
```
:::

## GET /api/{spaceId}/certificates/{id}/usages
## Get the usages of a certificate

:endpoint{method="GET" path="/api/\{spaceId\}/certificates/\{id\}/usages"}

Also reachable at `/api/certificates/{id}/usages`, `/api/spaces/{spaceIdentifier}/certificates/{id}/usages`.

Get the usages of a certificate

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand Down
6 changes: 4 additions & 2 deletions src/pages/docs/api/_generated/cloud-template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Cloud Template
---

## Request the metadata (ie, parameters and values) for a cloud template (eg, cloudformation, terraform, azure ARM template)
## Get metadata for a cloud template

:endpoint{method="POST" path="/api/cloudtemplate/\{id\}/metadata"}

Request the metadata (ie, parameters and values) for a cloud template (eg, cloudformation, terraform, azure ARM template)

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*
Expand Down
10 changes: 7 additions & 3 deletions src/pages/docs/api/_generated/deployment-targets.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Deployment Targets
---

## List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name
## List machines

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

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

List all the registered machines in the supplied Octopus Deploy Space, from all environments. The results will be sorted alphabetically by name.

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
Expand Down Expand Up @@ -756,12 +758,14 @@ Also reachable at `/api/machines/operatingsystem/shells/all`, `/api/spaces/{spac
```
:::

## List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name
## List machines sorted by health status

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

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

List all of the registered machines in the supplied Octopus Deploy Space, from all environments. The results are sorted by health status, healthiest first, then alphabetically by name.

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
Expand Down
8 changes: 5 additions & 3 deletions src/pages/docs/api/_generated/environments.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-27
modDate: 2026-09-03
title: Environments
---

Expand Down Expand Up @@ -395,7 +395,7 @@ Lists the name and ID of all of the environments in the supplied Space. The resu
```
:::

## PUT /api/{spaceId}/environments/sortorder
## Set Environment sort order

:endpoint{method="PUT" path="/api/\{spaceId\}/environments/sortorder"}

Expand Down Expand Up @@ -806,12 +806,14 @@ Lists all of the environments in the supplied Octopus Deploy Space. The results
```
:::

## List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments)
## List environments including Ephemeral

:endpoint{method="GET" path="/api/\{spaceId\}/environments/v2"}

Also reachable at `/api/spaces/{spaceIdentifier}/environments/v2`.

List Static, Parent and Ephemeral Environments in the supplied Octopus Deploy Space. The results will be sorted by the `SortOrder` field on each environment (which is set to a MaxValue integer for Ephemeral Environments).

**Path Parameters**

- **`spaceId`** :span[string]{.type-label} *(required)*
Expand Down
14 changes: 10 additions & 4 deletions src/pages/docs/api/_generated/git-hub.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Git Hub
---

Expand Down Expand Up @@ -492,10 +492,12 @@ Also reachable at `/api/spaces/{spaceIdentifier}/github/installations`.

`200` — OK

## Get the GitHub repositories for an installation visible to the current user https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-repositories-accessible-to-the-user-access-token
## Get the GitHub repositories for an installation visible to the current user

:endpoint{method="GET" path="/api/github/installations/\{installationId\}/repositories"}

https://docs.github.com/en/rest/apps/installations?apiVersion=2022-11-28#list-repositories-accessible-to-the-user-access-token

**Path Parameters**

- **`installationId`** :span[string]{.type-label} *(required)*
Expand Down Expand Up @@ -550,10 +552,12 @@ Also reachable at `/api/spaces/{spaceIdentifier}/github/installations`.
```
:::

## Reset the GitHub app registration for this Octopus instance. This is a destructive command and will break all existing GitHub app connections across the instance. This should only be used as a last resort to recover connectivity with GitHub
## Reset the GitHub app registration for this Octopus instance

:endpoint{method="POST" path="/api/github/reset-registration"}

This is a destructive command and will break all existing GitHub app connections across the instance. This should only be used as a last resort to recover connectivity with GitHub.

**Response**

`200` — GitHub app registration was successfully deleted
Expand All @@ -564,10 +568,12 @@ Also reachable at `/api/spaces/{spaceIdentifier}/github/installations`.
```
:::

## Search for GitHub repositories for an account visible to the current user https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repositories
## Search for GitHub repositories for an account visible to the current user

:endpoint{method="GET" path="/api/github/search/\{accountName\}/repositories"}

https://docs.github.com/en/rest/search/search?apiVersion=2022-11-28#search-repositories

**Path Parameters**

- **`accountName`** :span[string]{.type-label} *(required)*
Expand Down
8 changes: 4 additions & 4 deletions src/pages/docs/api/_generated/insights.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Api.astro
pubDate: 2026-08-11
modDate: 2026-08-11
modDate: 2026-09-03
title: Insights
---

Expand Down Expand Up @@ -462,7 +462,7 @@ Creates a new Insights Report.
```
:::

## GET /api/{spaceId}/insights/reports/{id}
## Get an Insights Report by ID

:endpoint{method="GET" path="/api/\{spaceId\}/insights/reports/\{id\}"}

Expand Down Expand Up @@ -749,7 +749,7 @@ Deletes an existing Insights Report.

`200` — Success

## GET /api/{spaceId}/insights/reports/{id}/v1
## Get an Insights Report by ID

:endpoint{method="GET" path="/api/\{spaceId\}/insights/reports/\{id\}/v1"}

Expand Down Expand Up @@ -1095,7 +1095,7 @@ Also reachable at `/api/spaces/{spaceIdentifier}/insights/reports/{reportId}/dep
```
:::

## GET /api/{spaceId}/insights/reports/{reportId}/logo
## Get the logo for an Insights Report

:endpoint{method="GET" path="/api/\{spaceId\}/insights/reports/\{reportId\}/logo"}

Expand Down
Loading