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
60 changes: 59 additions & 1 deletion 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-11
modDate: 2026-08-27
title: Environments
---

Expand Down Expand Up @@ -1432,3 +1432,61 @@ Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environmen
}
```
:::

## Delete the environment state entry with the given key for a project/environment (and optionally tenant)

:endpoint{method="DELETE" path="/api/\{spaceId\}/projects/\{projectId\}/environments/\{environmentId\}/tenants/\{tenantId\}/states/\{key\}"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/tenants/{tenantId}/states/{key}`, `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}`, `/api/{spaceId}/projects/{projectId}/environments/{environmentId}/untenanted/states/{key}`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
The ID of the environment the environment state entry belongs to.
- **`key`** :span[string]{.type-label} *(required)*
The key of the environment state entry to delete.
- **`projectId`** :span[string]{.type-label} *(required)*
The ID of the project the environment state entry belongs to.
- **`spaceId`** :span[string]{.type-label} *(required)*
The ID of the space containing the environment state entry.
- **`tenantId`** :span[string]{.type-label} *(required)*
An ID for a Tenant. If supplied, the entry deleted is the one published for the Tenant identified by the ID. If not supplied, the untenanted entry is deleted.

**Response**

`200` — Success

## Gets the set of URLs published for a project/environment (and optionally tenant)

:endpoint{method="GET" path="/api/\{spaceId\}/projects/\{projectId\}/environments/\{environmentId\}/urls"}

Also reachable at `/api/spaces/{spaceIdentifier}/projects/{projectId}/environments/{environmentId}/urls`.

**Path Parameters**

- **`environmentId`** :span[string]{.type-label} *(required)*
- **`projectId`** :span[string]{.type-label} *(required)*
- **`spaceId`** :span[string]{.type-label} *(required)*

**Query Parameters**

- **`tenantId`** :span[string]{.type-label}
An ID for a Tenant. If supplied, will limit the result to URLs published for the Tenant identified by the ID. If not supplied, only untenanted URLs are returned.

**Response**

`200` — The requested set of environment URLs

- **`Name`** :span[string]{.type-label}
- **`Url`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
[
{
"Name": "string",
"Url": "string"
}
]
```
:::
20 changes: 19 additions & 1 deletion src/pages/docs/api/_generated/platform-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-25
modDate: 2026-08-27
title: Platform Hub
---

Expand Down Expand Up @@ -2737,6 +2737,8 @@ Gets a set of GitHub App connections for the Platform Hub.
- **`Type`** :span[enum]{.type-label}
Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`.
- **`DefaultBranch`** :span[string]{.type-label}
- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label}
- **`ProtectedDefaultBranch`** :span[boolean]{.type-label}
- **`Url`** :span[string]{.type-label}

:::api-example{label="Response"}
Expand All @@ -2747,6 +2749,10 @@ Gets a set of GitHub App connections for the Platform Hub.
"Type": "Anonymous"
},
"DefaultBranch": "string",
"ProtectedBranchNamePatterns": [
"string"
],
"ProtectedDefaultBranch": false,
"Url": "string"
}
```
Expand All @@ -2763,6 +2769,8 @@ Gets a set of GitHub App connections for the Platform Hub.
- **`Type`** :span[enum]{.type-label}
Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`.
- **`DefaultBranch`** :span[string]{.type-label} *(required)*
- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label}
- **`ProtectedDefaultBranch`** :span[boolean]{.type-label}
- **`Url`** :span[string]{.type-label} *(required)*
Minimum length 1.

Expand All @@ -2774,6 +2782,10 @@ Gets a set of GitHub App connections for the Platform Hub.
"Type": "Anonymous"
},
"DefaultBranch": "string",
"ProtectedBranchNamePatterns": [
"string"
],
"ProtectedDefaultBranch": false,
"Url": "string"
}
```
Expand All @@ -2788,6 +2800,8 @@ Gets a set of GitHub App connections for the Platform Hub.
- **`Type`** :span[enum]{.type-label}
Allowed values: `Anonymous`, `UsernamePassword`, `Reference`, `GitHub`, `SshKey`.
- **`DefaultBranch`** :span[string]{.type-label}
- **`ProtectedBranchNamePatterns`** :span[array of string]{.type-label}
- **`ProtectedDefaultBranch`** :span[boolean]{.type-label}
- **`Url`** :span[string]{.type-label}

:::api-example{label="Response"}
Expand All @@ -2798,6 +2812,10 @@ Gets a set of GitHub App connections for the Platform Hub.
"Type": "Anonymous"
},
"DefaultBranch": "string",
"ProtectedBranchNamePatterns": [
"string"
],
"ProtectedDefaultBranch": false,
"Url": "string"
}
```
Expand Down