Pulumi Cloud REST API docs
The Pulumi Cloud REST API is used by the Pulumi CLI to query and interact with state information, history, stack tags, etc. This API is available for end users to integrate into their own automation use cases.
Endpoint URL
For the Managed Pulumi Cloud (i.e. app.pulumi.com), API endpoints are prefixed with the following url:
https://api.pulumi.com
If you are using Self-Hosted Pulumi Cloud, then use the configured endpoint for the Pulumi API component (e.g. https://api.pulumi.example.com
).
Authentication
All requests must be authenticated using a token via the Authorization
HTTP header.
The Authorization
header must be in the form below with the literal string token
, then a space, then your access token value.
Authorization: token {token}
To view your access tokens, or create a new one, view the Access Tokens page. You will see a list of past tokens, when they were last used, and have the ability to revoke them.
The Pulumi Cloud REST API will return a 401 status code if the token is missing or invalid.
Required Request Headers
The following headers are required for all operations except where explicitly noted:
Accept: application/vnd.pulumi+8
Content-Type: application/json
Stacks
List Stacks
Lists stacks available to the authenticated user.
GET /api/user/stacks
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | query | Optional. organization name to filter stacks by |
project | string | query | Optional. organization name to filter stacks by |
tagName | string | query | Optional. tag name to filter stacks by |
tagValue | string | query | Optional. tag value to filter stacks by |
continuationToken | string | query | Optional. the continuation token to use for retrieving the next set of results if results were truncated |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
https://api.pulumi.com/api/user/stacks?organization={organization}&tagName={tagName}&tagValue={tagValue}
Default response
Status: 200 OK
{
"stacks": [
{
"orgName": "org1",
"projectName": "project1",
"stackName": "dev",
"lastUpdate": 1612481387,
"resourceCount": 0
},
{
"orgName": "org2",
"projectName": "project2",
"stackName": "prod",
"lastUpdate": 1605474464,
"resourceCount": 0
}
],
"continuationToken": "5-"
}
Get Stack
GET /api/stacks/{organization}/{project}/{stack}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
Example
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}
Default response
Status: 200 OK
{
"orgName": "demo",
"projectName": "demo-aws-ts-webserver",
"stackName": "dev-user1",
"currentOperation": {
"kind": "update",
"author": "user1",
"started": 1615872156
},
"activeUpdate": "d333a711-4aa0-402f-be6d-72af9665fc37",
"tags": {
"gitHub:owner": "pulumi",
"gitHub:repo": "customer-engineering",
"pulumi:description": "A minimal AWS TypeScript Pulumi program",
"pulumi:project": "demo-aws-ts-webserver",
"pulumi:runtime": "nodejs",
"pulumi:secrets_provider": "service",
"vcs:kind": "github.com",
"vcs:owner": "pulumi",
"vcs:repo": "customer-engineering"
},
"version": 91
}
Get Stack State
GET /api/stacks/{organization}/{project}/{stack}/export
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
Example
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}/export
Default response
Status: 200 OK
{
"version": 3,
"deployment": {
"manifest": {
"time": "2021-03-15T22:29:53.782994-07:00",
"magic": "6ed32cc63f3d459cb6f52bb150bc8ff68db740bf43964d429d5ca57f52c832b1",
"version": "v2.22.0"
},
"secrets_providers": {
"type": "service",
"state": {
"url": "https://api.pulumi.com",
"owner": "org1",
"project": "demo-aws-ts-webserver",
"stack": "dev-user1"
}
},
"resources": [
{
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"custom": false,
"type": "pulumi:pulumi:Stack",
"outputs": {
"vpcId": "vpc-04057e18647a66e24"
}
},
{
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:providers:aws::default_3_32_0",
"custom": true,
"id": "d77c9fd7-1c06-427d-ba26-dbd8a8cbf91a",
"type": "pulumi:providers:aws",
"inputs": {
"region": "us-west-2",
"version": "3.32.0"
},
"outputs": {
"region": "us-west-2",
"version": "3.32.0"
}
},
{
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"custom": true,
"id": "vpc-04057e18647a66e24",
"type": "aws:ec2/vpc:Vpc",
"inputs": {
"__defaults": [
"assignGeneratedIpv6CidrBlock",
"enableDnsSupport",
"instanceTenancy"
],
"assignGeneratedIpv6CidrBlock": false,
"cidrBlock": "10.0.0.0/16",
"enableDnsSupport": true,
"instanceTenancy": "default"
},
"outputs": {
"__meta": "{\"schema_version\":\"1\"}",
"arn": "arn:aws:ec2:us-west-2:0123456789:vpc/vpc-04057e18647a66e24",
"assignGeneratedIpv6CidrBlock": false,
"cidrBlock": "10.0.0.0/16",
"defaultNetworkAclId": "acl-0b63012743b57140d",
"defaultRouteTableId": "rtb-01c36ce5fcc3ac797",
"defaultSecurityGroupId": "sg-072f0a9bf075de1f5",
"dhcpOptionsId": "dopt-6db97615",
"enableClassiclink": false,
"enableClassiclinkDnsSupport": false,
"enableDnsHostnames": false,
"enableDnsSupport": true,
"id": "vpc-04057e18647a66e24",
"instanceTenancy": "default",
"ipv6AssociationId": "",
"ipv6CidrBlock": "",
"mainRouteTableId": "rtb-01c36ce5fcc3ac797",
"ownerId": "0123456789",
"tags": {}
},
"parent": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"provider": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:providers:aws::default_3_32_0::d77c9fd7-1c06-427d-ba26-dbd8a8cbf91a",
"propertyDependencies": {
"cidrBlock": null
}
}
]
}
}
Transfer Stack
Transfers the stack from one organization in the Pulumi Cloud to a different organization. The user calling this operation must have the necessary stack permissions for this operation to be successful.
This operation will return a 409 response error if an update is currently in progress.
POST /api/stacks/{organization}/{project}/{stack}/transfer
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
toOrg | string | body | the organization to transfer the stack to |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"toOrg":"{toOrg}"}' \
https://api.pulumi.com/api/stacks/{organization}/{project}/{stack}/transfer
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Delete Stack
DELETE /api/stacks/{organization}/{project}/{stack}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
force | boolean | query | flag indicating to delete the stack even if it still contains resources |
Example
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/stacks/{organization}/{project}/{stack}
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Stack Tags
Get Stack Tags
Use Get Stack to retrieve a stack’s details including its tags.
Set Stack Tag
POST /api/stacks/{organization}/{project}/{stack}/tags
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
name | string | body | tag name |
value | string | body | tag value |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"name":"{tagName}","value":"{tagValue}"}' \
https://api.pulumi.com/api/stacks/{organization}/{project}/{stack}/tags
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Delete Stack Tag
DELETE /api/stacks/{organization}/{project}/{stack}/tags/{tagName}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
tagName | string | path | tag name |
Example
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/stacks/{organization}/{project}/{stack}/tags/{tagName}
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Stack Updates
List Stack Updates
GET /api/stacks/{organization}/{project}/{stack}/updates
By default the results are not paginated. You can specify page
and pageSize
query parameters to paginate the results.
?pageSize=1&page=1
can be used to return only the most recent update.
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
page | number | query | Optional. page of the results to return |
pageSize | number | query | Optional. number of results per page |
output-type | number | query | Optional. the response format to return - possible values are service or cli (default) |
Example
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}/updates?output-type=service
Default response
Status: 200 OK
{
"updates": [
{
"info": {
"kind": "update",
"startTime": 1615872578,
"message": "Add `gcp-py-webserver` demo. (#160)",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "e61b846e6e8395338bce1053c2edb29ee3213b4b",
"git.headName": "refs/heads/master",
"github.pr.number": "160",
"vcs.kind": "github.com",
"vcs.owner": "org1",
"vcs.repo": "repo1"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "succeeded",
"endTime": 1615872594,
"version": 95,
"resourceChanges": {
"create": 2
}
},
"updateID": "938cd018-3ecc-4a9e-86dd-42e84fefcc9c",
"githubCommitInfo": {
"slug": "org1/repo1",
"sha": "e61b846e6e8395338bce1053c2edb29ee3213b4b",
"url": "https://github.com/org1/repo1/commit/e61b846e6e8395338bce1053c2edb29ee3213b4b",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 95,
"latestVersion": 95,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
},
"policyPacks": [
{
"name": "aws",
"displayName": "",
"version": 23,
"versionTag": "0.1.20201015-2",
"config": {
"allowed-image-owner": {
"allowedPublishers": [
"self",
"099720109477"
]
},
"maximum-instance-count": {
"maximumInstanceCount": 2
},
"prohibited-services": {
"enforcementLevel": "advisory"
},
"require-region": {
"allowedRegions": [
"us-west-2"
]
},
"vpc-sizing": {
"enforcementLevel": "advisory",
"maxSubnetPrefixLength": 22
}
}
},
{
"name": "azure",
"displayName": "",
"version": 12,
"versionTag": "0.1.20200912",
"config": {
"allowed-image-owner": {
"allowedPublishers": [
"canonical"
]
},
"maximum-instance-count": {
"enforcementLevel": "advisory",
"maximumInstanceCount": 2
},
"prohibited-services": {
"enforcementLevel": "advisory"
},
"vpc-sizing": {
"maxSubnetPrefixLength": 22
}
}
},
{
"name": "k8s",
"displayName": "",
"version": 13,
"versionTag": "0.1.20201105-1",
"config": {
"replica-count": {
"enforcementLevel": "advisory"
}
}
},
{
"name": "cost-optimization",
"displayName": "",
"version": 9,
"versionTag": "0.1.20201015-3",
"config": {
"aws-budget-limit": {
"maxMonthlyCost": 50
},
"gcp-budget-limit": {
"maxMonthlyCost": 50
}
}
},
{
"name": "azure-nextgen",
"displayName": "",
"version": 3,
"versionTag": "0.1.20201222-1",
"config": {
"allowed-image-owner": {
"allowedPublishers": [
"canonical"
]
},
"maximum-instance-count": {
"maximumInstanceCount": 2
},
"vnet-sizing": {
"enforcementLevel": "advisory",
"maxSubnetPrefixLength": 22
}
}
},
{
"name": "gcp",
"displayName": "",
"version": 19,
"versionTag": "0.1.20200912",
"config": {
"allowed-image-owner": {
"allowedPublishers": [
"ubuntu-os-cloud"
]
},
"maximum-instance-count": {
"maximumInstanceCount": 2
},
"subnet-sizing": {
"maxSubnetPrefixLength": 22
}
}
}
]
},
{
"info": {
"kind": "destroy",
"startTime": 1615872573,
"message": "Add `gcp-py-webserver` demo. (#160)",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "e61b846e6e8395338bce1053c2edb29ee3213b4b",
"git.headName": "refs/heads/master",
"github.pr.number": "160",
"vcs.kind": "github.com",
"vcs.owner": "org1",
"vcs.repo": "repo1"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "succeeded",
"endTime": 1615872575,
"version": 94,
"resourceChanges": {
"delete": 2
}
},
"updateID": "d6a21779-99b7-42b1-b1f3-0f2045baa083",
"githubCommitInfo": {
"slug": "org1/repo1",
"sha": "e61b846e6e8395338bce1053c2edb29ee3213b4b",
"url": "https://github.com/org1/repo1/commit/e61b846e6e8395338bce1053c2edb29ee3213b4b",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 94,
"latestVersion": 95,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
}
],
"itemsPerPage": 10,
"total": 95
}
Get Update Status
GET /api/stacks/{organization}/{project}/{stack}/update/{updateID}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
updateID | uuid | path | update id - UUID as retrieved from List Stack Updates using ?output-type=service |
Example
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}/update/{updateID}
Default response
Status: 200 OK
{
"status": "succeeded",
"events": []
}
List Update Events
GET /api/stacks/{organization}/{project}/{stack}/update/{updateID}/events
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
updateID | uuid | path | update id - UUID as retrieved from List Stack Updates using ?output-type=service |
Example
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}/update/{updateID}/events
Default response
Status: 200 OK
{
"events": [
{
"timestamp": 1615872590,
"type": "preludeEvent",
"preludeEvent": {
"config": {
"aws:region": "us-west-2"
}
}
},
{
"timestamp": 1615872590,
"type": "resourcePreEvent",
"resourcePreEvent": {
"metadata": {
"op": "create",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"type": "pulumi:pulumi:Stack",
"old": null,
"new": {
"type": "pulumi:pulumi:Stack",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"id": "",
"parent": "",
"inputs": {},
"outputs": {},
"provider": ""
},
"logical": true,
"provider": ""
}
}
},
{
"timestamp": 1615872593,
"type": "policyEvent",
"policyEvent": {
"resourceUrn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"message": "<{%reset%}>VPCs must be of appropriate size.\nAddress space [10.0.0.0/16] is too large. Must be [/22] or smaller.<{%reset%}>\n",
"color": "raw",
"policyName": "vpc-sizing",
"policyPackName": "aws",
"policyPackVersion": "0.1.20201015-2",
"policyPackVersionTag": "0.1.20201015-2",
"enforcementLevel": "advisory"
}
},
{
"timestamp": 1615872593,
"type": "resourcePreEvent",
"resourcePreEvent": {
"metadata": {
"op": "create",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"type": "aws:ec2/vpc:Vpc",
"old": null,
"new": {
"type": "aws:ec2/vpc:Vpc",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"custom": true,
"id": "",
"parent": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"inputs": {
"__defaults": [
"assignGeneratedIpv6CidrBlock",
"enableDnsSupport",
"instanceTenancy"
],
"assignGeneratedIpv6CidrBlock": false,
"cidrBlock": "10.0.0.0/16",
"enableDnsSupport": true,
"instanceTenancy": "default"
},
"outputs": {},
"provider": ""
},
"logical": true,
"provider": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:providers:aws::default_3_32_0::d77c9fd7-1c06-427d-ba26-dbd8a8cbf91a"
}
}
},
{
"timestamp": 1615872593,
"type": "resOutputsEvent",
"resOutputsEvent": {
"metadata": {
"op": "create",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"type": "aws:ec2/vpc:Vpc",
"old": null,
"new": {
"type": "aws:ec2/vpc:Vpc",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::aws:ec2/vpc:Vpc::main",
"custom": true,
"id": "vpc-04057e18647a66e24",
"parent": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"inputs": {
"__defaults": [
"assignGeneratedIpv6CidrBlock",
"enableDnsSupport",
"instanceTenancy"
],
"assignGeneratedIpv6CidrBlock": false,
"cidrBlock": "10.0.0.0/16",
"enableDnsSupport": true,
"instanceTenancy": "default"
},
"outputs": {
"__meta": "{\"schema_version\":\"1\"}",
"arn": "arn:aws:ec2:us-west-2:0123456789:vpc/vpc-04057e18647a66e24",
"assignGeneratedIpv6CidrBlock": false,
"cidrBlock": "10.0.0.0/16",
"defaultNetworkAclId": "acl-0b63012743b57140d",
"defaultRouteTableId": "rtb-01c36ce5fcc3ac797",
"defaultSecurityGroupId": "sg-072f0a9bf075de1f5",
"dhcpOptionsId": "dopt-6db97615",
"enableClassiclink": false,
"enableClassiclinkDnsSupport": false,
"enableDnsHostnames": false,
"enableDnsSupport": true,
"id": "vpc-04057e18647a66e24",
"instanceTenancy": "default",
"ipv6AssociationId": "",
"ipv6CidrBlock": "",
"mainRouteTableId": "rtb-01c36ce5fcc3ac797",
"ownerId": "0123456789",
"tags": {}
},
"provider": ""
},
"logical": true,
"provider": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:providers:aws::default_3_32_0::d77c9fd7-1c06-427d-ba26-dbd8a8cbf91a"
}
}
},
{
"timestamp": 1615872593,
"type": "resOutputsEvent",
"resOutputsEvent": {
"metadata": {
"op": "create",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"type": "pulumi:pulumi:Stack",
"old": null,
"new": {
"type": "pulumi:pulumi:Stack",
"urn": "urn:pulumi:dev-user1::demo-aws-ts-webserver::pulumi:pulumi:Stack::demo-aws-ts-webserver-dev-user1",
"id": "",
"parent": "",
"inputs": {},
"outputs": {
"vpcId": "vpc-04057e18647a66e24"
},
"provider": ""
},
"logical": true,
"provider": ""
}
}
},
{
"timestamp": 1615872593,
"type": "summaryEvent",
"summaryEvent": {
"maybeCorrupt": false,
"durationSeconds": 4,
"resourceChanges": {
"create": 2
},
"PolicyPacks": {
"aws": "23",
"azure": "12",
"azure-nextgen": "3",
"cost-optimization": "9",
"gcp": "19",
"k8s": "13"
}
}
}
],
"continuationToken": null
}
List Previews
List all previews since the last update operation.
GET /api/stacks/{organization}/{project}/{stack}/updates/latest/previews
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
Example
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}/updates/latest/previews
Default response
Status: 200 OK
{
"updates": [
{
"info": {
"kind": "Pupdate",
"startTime": 1624932955,
"message": "triggered by pr #12",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"git.headName": "refs/heads/master",
"vcs.kind": "github.com",
"vcs.owner": "pulumi",
"vcs.repo": "examples"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "failed",
"endTime": 1624932956,
"version": 1,
"resourceChanges": {
"create": 0,
"delete": 0,
"same": 0,
"update": 0
}
},
"updateID": "c30c74e6-9576-4c63-95a4-4f96e7793ebb",
"githubCommitInfo": {
"slug": "pulumi/examples",
"sha": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"url": "https://github.com/pulumi/examples/commit/35caae8d73c3ecb0eac1256ba0e03775f24514da",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 1,
"latestVersion": 0,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
{
"info": {
"kind": "Pupdate",
"startTime": 1624932977,
"message": "triggered by pr #12",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"git.headName": "refs/heads/master",
"vcs.kind": "github.com",
"vcs.owner": "pulumi",
"vcs.repo": "examples"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "failed",
"endTime": 1624932992,
"version": 1,
"resourceChanges": {
"create": 1
}
},
"updateID": "cf72ac80-4b87-4e26-9974-9eef3267995d",
"githubCommitInfo": {
"slug": "pulumi/examples",
"sha": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"url": "https://github.com/pulumi/examples/commit/35caae8d73c3ecb0eac1256ba0e03775f24514da",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 1,
"latestVersion": 0,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
{
"info": {
"kind": "Pupdate",
"startTime": 1624932999,
"message": "triggered by pr #12",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"git.headName": "refs/heads/master",
"vcs.kind": "github.com",
"vcs.owner": "pulumi",
"vcs.repo": "examples"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "succeeded",
"endTime": 1624933003,
"version": 1,
"resourceChanges": {
"create": 3
}
},
"updateID": "9a6ffbb0-cb82-420f-824a-efac39ac91c8",
"githubCommitInfo": {
"slug": "pulumi/examples",
"sha": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"url": "https://github.com/pulumi/examples/commit/35caae8d73c3ecb0eac1256ba0e03775f24514da",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 1,
"latestVersion": 0,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
{
"info": {
"kind": "Pupdate",
"startTime": 1624933009,
"message": "triggered by pr #13",
"environment": {
"exec.kind": "cli",
"git.author": "First Last",
"git.author.email": "user1@example.com",
"git.committer": "GitHub",
"git.committer.email": "noreply@github.com",
"git.dirty": "true",
"git.head": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"git.headName": "refs/heads/master",
"vcs.kind": "github.com",
"vcs.owner": "pulumi",
"vcs.repo": "examples"
},
"config": {
"aws:region": {
"string": "us-west-2",
"secret": false,
"object": false
}
},
"result": "succeeded",
"endTime": 1624933012,
"version": 1,
"resourceChanges": {
"create": 3
}
},
"updateID": "4c51a52c-6344-4664-8698-02e068060e5a",
"githubCommitInfo": {
"slug": "pulumi/examples",
"sha": "35caae8d73c3ecb0eac1256ba0e03775f24514da",
"url": "https://github.com/pulumi/examples/commit/35caae8d73c3ecb0eac1256ba0e03775f24514da",
"author": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
"version": 1,
"latestVersion": 0,
"requestedBy": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
}
],
"itemsPerPage": 10,
"total": 4
}
Organizations
List Users
In the response data githubLogin
is synonymous with username
and does not necessarily mean the user is from a GitHub-backed organization.
knownToPulumi
and virtualAdmin
are internal implementation details that should not be referenced by an end user.
GET /api/orgs/{organization}/members?type=backend
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
type | string | query | must be set to backend |
continuationToken | string | query | Optional. the continuation token to use for retrieving the next set of results if results were truncated |
Example
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}/members?type=backend
Default response
Status: 200 OK
{
"members": [
{
"role": "member",
"user": {
"name": "First Last",
"githubLogin": "user2",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300",
"email": "user@example.com"
},
"knownToPulumi": true,
"virtualAdmin": false
},
{
"role": "admin",
"user": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300",
"email": "admin@example.com"
},
"knownToPulumi": true,
"virtualAdmin": false
}
]
}
Add User to Organization
User must have already signed up for a Pulumi account and meet the organization membership requirements to be added to the organization, otherwise a 4xx error will occur.
If you want to provision SSO/SAML users, please refer to the SCIM 2.0 Integration documentation.
POST /api/orgs/{organization}/members/{username}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
username | string | path | user name |
role | string | body | The role to assign - possible values are admin or member |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"role":"{role}"}' \
https://api.pulumi.com/api/orgs/{organization}/members/{username}
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Remove User from Organization
DELETE /api/orgs/{organization}/members/{username}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
username | string | path | user name |
Example
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/{organization}/members/{username}
Default response
Status: 200 OK
EMPTY RESPONSE BODY
List Teams
GET /api/orgs/{organization}/teams
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
continuationToken | string | query | Optional. the continuation token to use for retrieving the next set of results if results were truncated |
Example
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}/teams
Default Response
Status: 200 OK
{
"teams":[
{
"kind":"pulumi",
"name":"team1",
"displayName":"team1",
"description":"",
"userRole":"none"
},
{
"kind":"pulumi",
"name":"team2",
"displayName":"team2",
"description":"",
"userRole":"admin"
}
]
}
Create Team
teamType
path parameter must be github
. For all other organization types the teamType
path parameter must be pulumi
.POST /api/orgs/{org}/teams/{teamType}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
teamType | string | path | the type of team to create - valid options are pulumi or github |
name | string | body | team name |
displayName | string | body | Optional. team display name |
description | string | body | Optional. team description |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"name":"example-team","displayName":"example display name","description":"example description"}' \
https://api.pulumi.com/api/orgs/{org}/teams/pulumi
Default response
Status: 200 OK
{
"kind": "pulumi",
"name": "example-team",
"displayName": "example display name",
"description": "example description",
"members": [
{
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
]
}
Delete Team
DELETE /api/orgs/{org}/teams/{teamName}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
teamName | string | path | team name |
Example
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/{teamName}
Default response
Status: 200 OK
EMPTY RESPONSE BODY
Update Team Membership
- For GitHub-backed organizations, this operation cannot be used as membership is managed on GitHub.
- For SCIM managed teams, this operation cannot be used as membership is managed via the SSO provider.
PATCH /api/orgs/{organization}/teams/{team}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
team | string | path | team name |
memberAction | string | body | The action for the user and team - possible values are add or remove |
member | string | body | user name |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"memberAction":"{memberAction}","member":"{username}"}' \
https://api.pulumi.com/api/orgs/{organization}/teams/{team}
Default response
Status: 200 OK
EMPTY RESPONSE BODY
Grant Stack Access to Team
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
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
Status: 204 OK
EMPTY RESPONSE BODY
Remove Stack Access from Team
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
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
Status: 204 OK
EMPTY RESPONSE BODY
Update User’s Role
PATCH /api/orgs/{organization}/members/{username}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | query | organization name to filter stacks by |
username | string | path | user name |
role | string | body | The role to assign - possible values are admin or member |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request PATCH \
--data '{"role":"{role}"}' \
https://api.pulumi.com/api/orgs/{organization}/members/{username}
Default response
Status: 200 OK
EMPTY RESPONSE BODY
List User Access Tokens
GET /api/user/tokens
Parameters
None
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
https://api.pulumi.com/api/user/tokens
Default response
Status: 200 OK
{
"tokens": [
{
"id": "b02514e2-ddf6-41dc-8e16-6abf3914e68f",
"description": "Generated by pulumi login on workstation at 20 May 21 12:04 EDT",
"lastUsed": 1627590233
},
{
"id": "ad9f7508-493a-4fbe-9918-62f1f71a53f8",
"description": "cicd-server",
"lastUsed": 1606860942
}
]
}
Create User Access Token
POST /api/user/tokens
Parameters
Parameter | Type | In | Description |
---|---|---|---|
description | string | body | Descripton of the access token |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{"description":"{description}"}' \
https://api.pulumi.com/api/stacks/{organization}/{project}/{stack}/tags
Default response
Status: 204 OK
{
"id": "74529ccd-27c0-40f7-bc4a-589f145ba67f",
"tokenValue": "pul-75a564ac7f3a48079a0c448c1e1ec95c4cfed141"
}
Delete User Access Token
DELETE /api/user/tokens/{tokenId}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
tokenId | string | path | the token identifier |
Example
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/user/tokens/{tokenId}
Default response
Status: 204 OK
EMPTY RESPONSE BODY
Create Webhook
// To create an organization webhook
POST /api/orgs/{organization}/hooks
// To create a stack webhook
POST /api/stacks/{organization}/{project}/{stack}/hooks
Parameters
Parameter | Type | In | Description |
---|---|---|---|
active | boolean | body | enable webhook |
displayName | string | body | name of webhook |
organizationName | string | body | organization name |
payloadUrl | string | body | URL to send request to |
projectName | string | body | Optional. project name (required for stack webhooks) |
stackName | string | body | Optional. stack name (required for stack webhooks) |
format | string | body | Optional. format of the payload. Possible values are raw , slack , ms_teams or pulumi_deployments . Default is raw . |
filters | array[string] | body | Optional. list of filters for events the webhook should receive. See webhook docs for more information on what filters are available |
secret | string | body | Optional. secret used as the HMAC key. See webhook docs for more information |
Examples
Create an organization webhook
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{
"organizationName":"{organization}",
"displayName":"My Webhook",
"payloadUrl":"https://example.com",
"secret":"mysecret",
"active":true
}' \
https://api.pulumi.com/api/orgs/{organization}/hooks
Default Response
Status: 201 CREATED
{
"organizationName":"{organization}",
"name":"bd7e0a35",
"displayName":"My Webhook",
"payloadUrl":"https://example.com",
"active":true,
"format":"raw"
}
Create a stack webhook formatted for slack
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"displayName":"#some-slack-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format": "slack",
"active":true
}' \
https://api.pulumi.com/api/orgs/{organization}/{project}/{stack}/hooks
Default Response
Status: 201 CREATED
{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"name":"bd7e0a35",
"displayName":"#some-slack-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format":"slack",
"active":true
}
Create a stack webhook with filters
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"displayName":"#stack_failures-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format": "slack",
"filters": ["preview_failed", "update_failed", "destroy_failed", "refresh_failed", "deployment_failed"],
"active":true
}' \
https://api.pulumi.com/api/orgs/{organization}/{project}/{stack}/hooks
Create a Deployment webhook
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
--data '{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"displayName":"deployDownstreamStack",
"payloadUrl":"{downstreamProject}/{downstreamStack}",
"format": "pulumi_deployments",
"filters": ["update_succeeded"],
"active":true
}' \
https://api.pulumi.com/api/orgs/{organization}/{project}/{stack}/hooks
Default response
Default Response
Status: 201 CREATED
{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"name":"bd7e0a35",
"displayName":"#stack_failures-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format":"slack",
"filters":["preview_failed", "update_failed", "destroy_failed", "refresh_failed", "deployment_failed"],
"active":true
}
List Webhooks
List organization webhooks
GET /api/orgs/{organization}/hooks
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
Example
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
Default response
[
{
"organizationName":"{organization}",
"name":"4e662b3b",
"displayName":"MyWebhook",
"payloadUrl":"https://example.com",
"format":"raw",
"active":true
},
{
"organizationName":"{organization}",
"name":"7732dd4c",
"displayName":"My secret webhook",
"payloadUrl":"https://hooks.slack.com/services/...",
"format":"slack",
"active":true
}
]
List stack webhooks
GET /api/stacks/{organization}/{project}/{stack}/hooks
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
Example
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
Default response
[
{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"name":"4e662b3b",
"displayName":"My stack webhook",
"payloadUrl":"https://example.com",
"active":true
},
{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"name":"7732dd4c",
"displayName":"#failures-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format":"slack",
"filters":["preview_failed", "update_failed", "destroy_failed", "refresh_failed", "deployment_failed"],
"active":true
}
]
Get Webhook
Get organization webhook
GET /api/orgs/{organization}/hooks/{webhookname}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
webhookname | string | path | webhook name |
Example
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}
Default response
Status: 200 OK
{
"organizationName":"{organization}",
"name":"{webhookname}",
"displayName":"My Webhook",
"payloadUrl":"https://example.com",
"format":"raw",
"active":true
}
Get stack webhook
GET /api/stacks/{organization}/{project}/{stack}/hooks/{webhookname}
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
project | string | path | project name |
stack | string | path | stack name |
webhookname | string | path | webhook name |
Example
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}
Default response
Status: 200 OK
{
"organizationName":"{organization}",
"projectName":"{project}",
"stackName":"{stack}",
"name":"{webhookname}",
"displayName":"#failures-channel",
"payloadUrl":"https://hooks.slack.com/services/...",
"format":"slack",
"filters":["preview_failed", "update_failed", "destroy_failed", "refresh_failed", "deployment_failed"],
"active":true
}
Ping Webhook
Ping organization webhook
POST /api/orgs/{organization}/hooks/{webhookname}/ping
Ping stack webhook
POST /api/stacks/{organization}/{project}/{stack}/hooks/{webhookname}/ping
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
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--request POST \
https://api.pulumi.com/api/orgs/{organization}/hooks/ping
Default response
Status: 200 OK
{
"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"
}
List webhook deliveries
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
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
Default response
[
{
"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"
}
]
Audit Logs
Get Audit Log Events (JSON)
GET /api/orgs/{organization}/auditlogs
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
startTime | unix timestamp | query | return audit log entries that occurred before (i.e., are older) than this timestamp |
userFilter | string | query | Optional. username (e.g. user1 ) to filter results by |
continuationToken | string | query | Optional. the continuation token to use for retrieving the next set of results if results were truncated |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Content-Type: application/json" \
-H "Authorization: token pul-abcdefghijklmnopqrstuvwxyz" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/auditlogs?startTime=1615872240
Default response
Status: 200 OK
{
"continuationToken": "1615413365",
"auditLogEvents": [
{
"timestamp": 1615413432,
"sourceIP": "10.0.0.1",
"event": "Stack Update Started",
"description": "Started update \"6f93fd86-b972-4402-9952-264c81639794\" for stack \"project1/dev\"",
"user": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
{
"timestamp": 1615413365,
"sourceIP": "10.0.0.1",
"event": "Stack Exported",
"description": "Exported stack project1/dev",
"user": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
},
{
"timestamp": 1615413365,
"sourceIP": "10.0.0.1",
"event": "Stack Update Started",
"description": "Started update \"da85cf90-4c7b-4dc4-9286-6ca58b4196e3\" for stack \"project1/dev\"",
"user": {
"name": "First Last",
"githubLogin": "user1",
"avatarUrl": "https://en.gravatar.com/userimage/17756222/cabc55626abae89ebe2d8ae946521e15.png?size=300"
}
}
]
}
Export Audit Log Events (CSV or CEF)
This API endpoint differs from other endpoints in the following ways:
- The response data is always gzip compressed.
- The
Content-Type: application/json
header is omitted.
GET /api/orgs/{organization}/auditlogs/export
Parameters
Parameter | Type | In | Description |
---|---|---|---|
organization | string | path | organization name |
startTime | unix timestamp | query | return audit log entries that occurred before (i.e., are older) than this timestamp |
userFilter | string | query | Optional. username (e.g. user1 ) to filter results by |
format | string | query | Optional. the response format to return - possible values are cef or csv (default) |
Example
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/auditlogs/export?startTime=1615872240&format=cef
Default response
Status: 200 OK
Timestamp,Name,Login,Event,Description,SourceIP,RequireOrgAdmin,RequireStackAdmin,AuthenticationFailure
2021-04-11T23:51:45Z,First Last,user1,Member Role Changed,"Changed organization role for ""user2"" to admin",192.168.10.11,true,false,false
2021-04-11T23:09:36Z,First Last,user1,Member Role Changed,"Changed organization role for ""user2"" to admin",192.168.10.11,true,false,false
2021-04-11T23:09:25Z,First Last,user1,Member Role Changed,"Changed organization role for ""user3"" to admin",192.168.10.11,true,false,false
2021-04-11T21:09:52Z,First Last,user1,Secret Decrypted,"Decrypted secret value for stack ""demo-aws-ts-webserver/dev-user1"" (cipher text suffix: ""tbpiX4c="")",192.168.10.11,false,false,false
Resources Under Management (RUM)
Get Resource Count Summary
GET /orgs/{organization}/resources/summary?granularity=<granularity>&lookbackDays=<days>
Example (hourly)
granularity=hourly
, the maximum lookbackDays
you can set is 2
curl \
-h "accept: application/vnd.pulumi+8" \
-h "authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/resources/summary?granularity=hourly&lookbackDays=1
Default response (hourly)
Status: 200 OK
{
"summary": [
{
"year": 2022,
"month": 8,
"day": 31,
"hour": 20,
"resources": 27378
},
"..."
]
}
Example (daily)
curl \
-H "Accept: application/vnd.pulumi+8" \
-H "Authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/resources/summary?granularity=daily&lookbackDays=2
Default response (daily)
Status: 200 OK
{
"summary": [
{
"year": 2022,
"month": 8,
"day": 30,
"resources": 27379
},
"..."
]
}
Example (weekly)
curl \
-h "accept: application/vnd.pulumi+8" \
-h "authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/resources/summary?granularity=weekly&lookbackDays=28
Default response (weekly)
Status: 200 OK
{
"summary": [
{
"year": 2022,
"weekNumber": 31,
"resources": 26432
},
"..."
]
}
Example (monthly)
curl \
-h "accept: application/vnd.pulumi+8" \
-h "authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/resources/summary?granularity=monthly&lookbackDays=90
Default response (monthly)
Status: 200 OK
{
"summary": [
{
"year": 2022,
"month": 6,
"resources": 24520
},
"..."
]
}
Example (yearly)
curl \
-h "accept: application/vnd.pulumi+8" \
-h "authorization: token $PULUMI_ACCESS_TOKEN" \
--compressed \
https://api.pulumi.com/api/orgs/{organization}/resources/summary?granularity=yearly&lookbackDays=730
Default response (yearly)
Status: 200 OK
{
"summary": [
{
"year": 2022,
"resources": 24380
},
"..."
]
}
Resource Search
The Resource Search API is currently is preview and subject to change.
Please post any bug reports or feature requests in the Pulumi Cloud Requests repo.
const headers = {
Accept: "application/json",
Authorization: "token pul-abc123",
};
const body = await (
await fetch("https://api.pulumi.com/api/orgs/{org}/search/resources", {
method: "GET",
headers: headers,
})
).json();
console.log(body);
const headers = {
Accept: "application/json",
Authorization: "token pul-abc123",
};
const body = await(
await fetch("https://api.pulumi.com/api/orgs/{org}/search/resources", {
method: "GET",
headers: headers,
}),
).json();
console.log(body);
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'token pul-abc123'
}
r = requests.get('https://api.pulumi.com/api/orgs/{org}/search/resources', headers = headers)
print(r.json())
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"token pul-abc123"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.pulumi.com/api/orgs/{org}/search/resources", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
public class HttpExample
{
private HttpClient Client { get; set; }
public HttpExample()
{
Client = new HttpClient();
}
public async Task MakeGetRequest()
{
string url = "https://api.pulumi.com/api/orgs/{org}/search/resources";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("https://api.pulumi.com/api/orgs/{org}/search/resources");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /api/orgs/{org}/search/resources
Search for resources belonging to the given organization.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org | path | string | true | Name of the organization to search. |
query | query | string | false | The search query to execute. If omitted all resources are returned (subject to any pagination limits). |
sort | query | array[string] | false | The field(s) by which to sort. |
asc | query | boolean | false | Whether to return results in ascending or descending sort order. |
size | query | integer | false | How many results to return at a time. |
page | query | number | false | The page of results to return. |
cursor | query | string | false | A continuation token for pagination that allows fetching more than 10,000 resources. |
facet | query | array[string] | false | If provided, an aggregation will be returned with the top-5 values for the given facet, along with how many resources have those values. |
properties | query | boolean | false | Whether to include resource properties in results. Not supported for all subscriptions. |
Detailed descriptions
org: Name of the organization to search. The organization can belong to a team, enterprise, or an individual user.
The provided authorization token must have access to this organization.
query: The search query to execute. If omitted all resources are returned (subject to any pagination limits).
sort: Results are returned sorted by this field value. If omitted, results are sorted according to their search relevance. If there is no query, results are sorted by their last modified time.
If specified more than once, the first parameter is the primary sort order and subsequent parameters control additional sorting criteria.
Allowed values: created, custom, delete, id, modified, module, name, package, parent.urn, pending, project, protected, provider.urn, stack, type, urn.
asc: Whether to return results in ascending or descending sort order. Results are returned in descending order by default.
size: How many results to return at a time.
page: The page of results to return.
The page
parameter can only be used to fetch up 10,000 resources. If a query matches more than 10,000 resources, the cursor
parameter should be used instead.
Paginating with the page
parameter is not transactional. The order of results can be impacted if a stack update completes while paginating.
cursor: A continuation token for pagination that allows fetching more than 10,000 resources.
Only available on Enterprise plans.
Paginating with the cursor
parameter is not transactional. The order of results can be impacted if a stack update completes while paginating.
facet: If provided, an aggregation will be returned with the top-5 values for the given facet, along with how many resources have those values.
This parameter can be provided multiple times to return aggregations for up to 5 dimensions.
Allowed values: created, custom, delete, id, modified, module, name, package, parent.urn, pending, project, protected, provider.urn, stack, type, urn.
properties: Whether to include resource properties in results. Not supported for all subscriptions.
Attempting to set this on an unsupported subscription results in a 402 status code. Contact us to upgrade your subscription.
Example responses
200 Response
{
"total": 10000,
"resources": [
{
"created": "string",
"custom": true,
"delete": true,
"dependencies": ["string"],
"id": "string",
"modified": "string",
"module": "string",
"name": "string",
"package": "string",
"parent.urn": "string",
"pending": "creating",
"project": "string",
"properties": {},
"protected": true,
"provider.urn": "string",
"stack": "string",
"type": "string",
"urn": "string"
}
],
"aggregations": {
"others": 0,
"results": [
{
"name": "string",
"count": 0
}
]
},
"pagination": {
"previous": "string",
"next": "string",
"cursor": "string"
}
}
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful search. | ResourceSearchResult |
400 | Bad Request | Bad request. Not safe to retry. | None |
402 | Unsupported Query | You attempted to use functionality not included in your Pulumi subscription. Not safe to retry. | None |
422 | Unprocessable Entity | Unprocessable query. Not safe to retry. | None |
500 | Internal Server Error | Server error. Safe to retry. | None |
Data Export
The Data Export API is only available to organizations using the Enterprise and Business Critical editions.
If you don’t see it in your organization, contact us.
The Data Export API is currently is preview and subject to change.
Please post any bug reports or feature requests in the Pulumi Cloud Requests repo.
const headers = {
Accept: "application/json",
Authorization: "token pul-abc123",
};
const body = await (
await fetch("https://api.pulumi.com/api/orgs/{org}/search/resources/export", {
method: "GET",
headers: headers,
})
).json();
console.log(body);
const headers = {
Accept: "application/json",
Authorization: "token pul-abc123",
};
const body = await(
await fetch("https://api.pulumi.com/api/orgs/{org}/search/resources/export", {
method: "GET",
headers: headers,
}),
).json();
console.log(body);
import requests
headers = {
'Accept': 'application/json',
'Authorization': 'token pul-abc123'
}
r = requests.get('https://api.pulumi.com/api/orgs/{org}/search/resources/export', headers = headers)
print(r.json())
package main
import (
"bytes"
"net/http"
)
func main() {
headers := map[string][]string{
"Accept": []string{"application/json"},
"Authorization": []string{"token pul-abc123"},
}
data := bytes.NewBuffer([]byte{jsonReq})
req, err := http.NewRequest("GET", "https://api.pulumi.com/api/orgs/{org}/search/resources/export", data)
req.Header = headers
client := &http.Client{}
resp, err := client.Do(req)
// ...
}
using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;
public class HttpExample
{
private HttpClient Client { get; set; }
public HttpExample()
{
Client = new HttpClient();
}
public async Task MakeGetRequest()
{
string url = "https://api.pulumi.com/api/orgs/{org}/search/resources/export";
var result = await GetAsync(url);
}
/// Performs a GET Request
public async Task GetAsync(string url)
{
//Start the request
HttpResponseMessage response = await Client.GetAsync(url);
//Validate result
response.EnsureSuccessStatusCode();
}
/// Deserialize object from request response
private async Task DeserializeObject(HttpResponseMessage response)
{
//Read body
string responseBody = await response.Content.ReadAsStringAsync();
//Deserialize Body to object
var result = JsonConvert.DeserializeObject(responseBody);
}
}
URL obj = new URL("https://api.pulumi.com/api/orgs/{org}/search/resources/export");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
GET /api/orgs/{org}/search/resources/export
Export resources matching a given query in CSV format.
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org | path | string | true | Name of the organization to search. |
query | query | string | false | The search query to execute. If omitted all resources are returned. |
sort | query | array[string] | false | Results are returned sorted by this field value. |
asc | query | boolean | false | Whether to return results in ascending or descending sort order. |
properties | query | boolean | false | Whether to return properties with results. |
Example responses
200 Response
< HTTP/1.1 200 OK
< Content-Type: application/octet-stream
< X-Pulumi-Request-Id: 5d286ad6-0aa6-424e-bc9f-945e1cb90952
< Date: Tue, 1 Apr 2023 00:00:00 GMT
< Transfer-Encoding: chunked
created,custom,delete,id,modified,module,name,package,parent_urn,pending,project,protected,provider_urn,stack,type,urn
Responses
Status | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Successful export. | CSV |
400 | Bad Request | Bad request. Not safe to retry. | None |
402 | Unsupported Query | You attempted to use functionality not included in your Pulumi subscription. Not safe to retry. | None |
422 | Unprocessable Entity | Unprocessable query. Not safe to retry. | None |
500 | Internal Server Error | Server error. Safe to retry. | None |
Schemas
ResourceSearchResult
The result of a Resource Search query.
{
"total": 10000,
"resources": [
{
"created": "string",
"custom": true,
"delete": true,
"dependencies": ["string"],
"id": "string",
"modified": "string",
"module": "string",
"name": "string",
"package": "string",
"parent.urn": "string",
"pending": "creating",
"project": "string",
"properties": {},
"protected": true,
"provider.urn": "string",
"stack": "string",
"type": "string",
"urn": "string"
}
],
"aggregations": {
"others": 0,
"results": [
{
"name": "string",
"count": 0
}
]
},
"pagination": {
"previous": "string",
"next": "string",
"continue": "string"
}
}
Properties
Name | Type | Description |
---|---|---|
total | integer(int64)|null | The total number of results matched by the query. |
resources | [ResourceResult] | Resources matching the query. |
aggregations | Aggregations | The result of any aggregations requested. |
pagination | Pagination | URIs for pagination, if appropriate. |
ResourceResult
An individual resource.
{
"created": "string",
"custom": true,
"delete": true,
"dependencies": ["string"],
"id": "string",
"modified": "string",
"module": "string",
"name": "string",
"package": "string",
"parent.urn": "string",
"pending": "creating",
"project": "string",
"properties": {},
"protected": true,
"provider.urn": "string",
"stack": "string",
"type": "string",
"urn": "string"
}
Properties
Name | Type | Description |
---|---|---|
created | string|null | The UTC time when the resource was created. Resources created or modified with CLI versions below 3.60 do not have created set. |
custom | boolean|null | Whether the resource is a CustomResource. |
delete | boolean|null | Whether the resource is marked for deletion in the next update. Typically indicates a resource that was not cleaned up due to an error. |
dependencies | [string] | The URN of other resources this resource explicitly or implicitly depends on. |
id | string|null | The physical name of the resource, as assigned by the resource’s provider. May not be set if the resource is pending creation. |
modified | string|null | The UTC time when the resource’s state was last modified during an update, refresh or import. Stacks modified with CLI versions below 3.60 record this for all resources as the time of the stack operation, regardless of whether the resource was modified. After CLI version 3.60 the resource’s modified time is only updated when the resource’s state is modified. |
module | string|null | The module component of the resource’s type. This is s3 for a resource of type aws:s3/bucket:Bucket . |
name | string|null | The logical name of the resource. Typically the first parameter provided to the resource when it was instantiated. |
package | string|null | The package component of the resource’s type. This is aws for a resource of type aws:s3/bucket:Bucket . |
parent.urn | string|null | The URN of the resource’s parent, if it has one. |
pending | string|null | The state of the resource if it is pending. Typically indicates an operation that was interrupted due to an error, possibly needing manual intervention to resolve. Allowed values: creating , deleting , updating , reading , importing . |
project | string|null | The project the resource belongs to. |
properties | object|null | The resource’s combined input and output values as recorded in Pulumi’s state. Only available to certain Pulumi subscriptions. |
protected | boolean|null | Whether the resource is [protected](/docs/concepts/options/protect] from deletion. |
provider.urn | string|null | The URN of the resource’s provider. |
stack | string|null | The Stack the resource belongs to. |
type | string|null | The type of the resource. |
urn | string|null | The URN of the resource. |
Aggregations
A collection of aggregated values.
{
"others": 0,
"results": [
{
"name": "string",
"count": 0
}
]
}
Properties
Name | Type | Description |
---|---|---|
others | integer(int64)|null | The number of resources not counted in the top 5 results. |
results | [AggregationResult] | The top 5 values for the given aggregation, and the number of resources with each of those values. |
AggregationResult
An aggregated value.
{
"name": "string",
"count": 0
}
Properties
Name | Type | Description |
---|---|---|
name | string|null | A value from the faceted dimension. |
count | integer(int64)|null | How many resources share that value. |
Pagination
URLs for fetching additional results.
If null, the request is invalid or does not permit pagination.
{
"previous": "string",
"next": "string",
"continue": "string"
}
Properties
Name | Type | Description |
---|---|---|
previous | string|null | When non-null, this is a URI to fetch the previous page of results. |
next | string|null | When non-null, this is a URI to fetch the next page of results. This only allows paginating through the first 10,000 results of a query. The continue parameter should be used to fetch more than 10,000 results. |
continue | string|null | When non-null, this is a URI to fetch the next page of results. Unlike the next property, repeatedly following continue allows paginating through an unbounded number of results.When paginating with continue , next and previous will always be null .continue is only available to Pulumi Enterprise customers. |
Thank you for your feedback!
If you have a question about how to use Pulumi, reach out in Community Slack.
Open an issue on GitHub to report a problem or suggest an improvement.