Skip to content

Restore missing REST API endpoints for teams and webhooks #16639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 25, 2025
Merged

Restore missing REST API endpoints for teams and webhooks #16639

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
218 changes: 217 additions & 1 deletion content/docs/reference/cloud-rest-api/organizations/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The API provides endpoints for the following categories of operations:
- Managing organization members (adding, updating, removing)
- Managing organization access tokens
- Creating and managing teams
- Managing team access tokens
- Managing team membership, stack permissions, and access tokens

## User Management

Expand Down Expand Up @@ -396,6 +396,222 @@ curl \
https://api.pulumi.com/api/orgs/{org}/teams/{teamName}
```

### Grant Stack Access to Team

Grant a team permissions to access a specific stack.

```plain
PATCH /api/orgs/{organization}/teams/{team}
```

#### Parameters

| Parameter | Type | In | Description |
|-----------------------------------|---------|--------|----------------------------------------------------------------------------|
| `organization` | string | path | organization name |
| `team` | string | path | team name |
| `addStackPermission` | object | body | object specifying stack and permissions - see following parameters |
| `addStackPermission.projectName` | string | object | project name |
| `addStackPermission.stackName` | string | object | stack name |
| `addStackPermission.permission` | integer | object | number representing stack permissions: 101 (read), 102 (edit), 103 (admin) |

#### Example

```bash
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request PATCH \
--data '{"addStackPermission":{"projectName":"{projectName}","stackName":"{stackName}","permission":{permission}}}' \
https://api.pulumi.com/api/orgs/{organization}/teams/{team}
```

#### Default response

```plain
Status: 204 OK
```

```plain
EMPTY RESPONSE BODY
```

### Remove Stack Access from Team

Remove a team's access to a specific stack.

```plain
PATCH /api/orgs/{organization}/teams/{team}
```

#### Parameters

| Parameter | Type | In | Description |
|----------------------------|--------|--------|--------------------------------------------------------------------|
| `organization` | string | path | organization name |
| `team` | string | path | team name |
| `removeStack` | object | body | object specifying stack and permissions - see following parameters |
| `removeStack.projectName` | string | object | project name |
| `removeStack.stackName` | string | object | stack name |

#### Example

```bash
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request PATCH \
--data '{"removeStack":{"projectName":"{projectName}","stackName":"{stackName}"}}' \
https://api.pulumi.com/api/orgs/{organization}/teams/{team}
```

#### Default response

```plain
Status: 204 OK
```

```plain
EMPTY RESPONSE BODY
```

## Team Access Tokens

### List Team Access Tokens

List all access tokens for a team.

```plain
GET /api/orgs/{org}/teams/{team}/tokens
```

#### Parameters

| Parameter | Type | In | Description |
|----------------|--------|-------|--------------------------------------------------------------------------------------------|
| `organization` | string | path | organization name |
| `team` | string | path | team name |
| `show_expired` | string | query | **Optional.** whether to return previously expired tokens with results. Defaults to false. |

#### Example

```bash
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
https://api.pulumi.com/api/orgs/{org}/teams/{team}/tokens?show_expired=true
```

#### Default response

```plain
Status: 200 OK
```

```plain
{
"tokens": [
{
"id": "b02514e2-ddf6-41dc-8e16-6abf3914e68f",
"description": "CI/CD token for AI team - Feb 2024",
"expires": 1719333788,
"lastUsed": 1627590233,
"name": "Feb2024CICD-AI"
},
{
"id": "ad9f7508-493a-4fbe-9918-62f1f71a53f8",
"description": "A team token for the AI team, created in Feb 2023",
"expires": 0,
"lastUsed": 1606860942,
"name": "Feb2023CICD-AI"
}
]
}
```

### Create Team Access Token

Create a new access token for a team.

```plain
POST /api/orgs/{org}/teams/{team}/tokens
```

#### Parameters

| Parameter | Type | In | Description |
|----------------|--------|------|------------------------------------------------------------------------------------------------------------------------------------|
| `organization` | string | path | organization name |
| `team` | string | path | team name |
| `description` | string | body | Description of the access token. |
| `name` | string | body | Unique name of the access token, up to 40 characters. Must be unique across the org, including deleted tokens. |
| `expires` | int | body | **Optional.** unix epoch timestamp at which the token should expire, up to two years from present. 0 for no expiry. Defaults to 0. |

#### Example

```bash
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"description": "{description}", "name": "{unique_name}", "expires": 0}' \
https://api.pulumi.com/api/orgs/{org}/teams/{team}/tokens
```

#### Default response

```plain
Status: 204 OK
```

```plain
{
"id": "74529ccd-27c0-40f7-bc4a-589f145ba67f",
"tokenValue": "pul-75a564ac7f3a48079a0c448c1e1ec95c4cfed141"
}
```

### Delete Team Access Token

Delete a team access token.

```plain
DELETE /api/orgs/{org}/teams/{team}/tokens/{tokenId}
```

#### Parameters

| Parameter | Type | In | Description |
|----------------|--------|------|----------------------|
| `organization` | string | path | organization name |
| `team` | string | path | team name |
| `tokenId` | string | path | the token identifier |

#### Example

```bash
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request DELETE \
https://api.pulumi.com/api/orgs/{org}/teams/{team}/tokens/{tokenId}
```

#### Default response

```plain
Status: 204 OK
```

```plain
EMPTY RESPONSE BODY
```

## Webhooks

For comprehensive information about webhooks including setup, configuration, event filtering, and complete API reference, see the [Webhooks documentation](/docs/deployments/webhooks/) and [Webhooks REST API reference](/docs/reference/cloud-rest-api/webhooks/).
63 changes: 63 additions & 0 deletions content/docs/reference/cloud-rest-api/webhooks/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ The API provides endpoints for the following operations:
- Getting webhook details
- Updating webhook configuration
- Testing webhooks with ping functionality
- Viewing webhook delivery history
- Deleting webhooks

## Create Webhook
Expand Down Expand Up @@ -265,3 +266,65 @@ curl \
--request POST \
https://api.pulumi.com/api/stacks/{organization}/{project}/{stack}/hooks/{webhookname}/ping
```

## List Webhook Deliveries

List the delivery history for a webhook, showing details about each webhook invocation including payload, response, and timing information.

```plain
// List organization webhook deliveries
GET /api/orgs/{organization}/hooks/{webhookname}/deliveries

// List stack webhook deliveries
GET /api/stacks/{organization}/{project}/{stack}/hooks/{webhookname}/deliveries
```

### Parameters

| Parameter | Type | In | Description |
|----------------|--------|------|--------------------------------------------------------|
| `organization` | string | path | organization name |
| `project` | string | path | project name (only for stack webhooks) |
| `stack` | string | path | stack name (only for stack webhooks) |
| `webhookname` | string | path | webhook name |

### Example

```bash
# List organization webhook deliveries
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
https://api.pulumi.com/api/orgs/{organization}/hooks/{webhookname}/deliveries

# List stack webhook deliveries
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
https://api.pulumi.com/api/stacks/{organization}/{project}/{stack}/hooks/{webhookname}/deliveries
```

### Default response

```plain
Status: 200 OK
```

```plain
[
{
"id": "ea01abd2-90b4-4670-acce-15cc019ed6e4",
"kind": "ping",
"payload": "{\"timestamp\":1632735487,\"message\":\"🍹 Just a friendly ping from Pulumi 🍹\"}",
"timestamp": 1632735487,
"duration": 196,
"requestUrl": "{webhookurl}",
"requestHeaders": "Content-Type: application/json\r\nPulumi-Webhook-Id: ea01abd2-90b4-4670-acce-15cc019ed6e4\r\nPulumi-Webhook-Kind: ping\r\n",
"responseCode": 200,
"responseHeaders": "{headersfromwebhook}",
"responseBody": "OK"
}
]
```
Loading