Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
Viewing docs for Pulumi Cloud v1.5.0
published on Monday, Oct 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

Pulumi Cloud (Pulumi Service provider)

pulumiservice logo pulumiservice logo
Viewing docs for Pulumi Cloud v1.5.0
published on Monday, Oct 19, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    The Pulumi Service provider for Pulumi can be used to provision resources available in Pulumi Cloud.

    Resource namespaces

    The provider has two sets of resources:

    • pulumiservice:index:* (for example, pulumiservice.Webhook) are designed and maintained by hand.
    • pulumiservice:api:* (for example, pulumiservice.api.OrganizationWebhook) are generated from the Pulumi Cloud REST API specification and cover more of the API.

    The api namespace is in preview. Its resource shapes and module layout may change before general availability.

    Installation

    npm install @pulumi/pulumiservice

    pip install pulumi-pulumiservice

    go get github.com/pulumi/pulumi-pulumiservice/sdk/go/pulumiservice

    dotnet add package Pulumi.PulumiService

    Maven:

    <dependency>
    <groupId>com.pulumi</groupId>
    <artifactId>pulumiservice</artifactId>
    <version>1.5.0</version>
</dependency>

    Gradle:

    implementation 'com.pulumi:pulumiservice:1.5.0'

    pulumi package add pulumiservice

    Declare the provider in your program, then run pulumi install:

    terraform {
  required_providers {
    pulumiservice = {
      source  = "pulumi/pulumiservice"
      version = "1.5.0"
    }
  }
}

    pulumi install

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as pulumiservice from "@pulumi/pulumiservice";
const webhook = new pulumiservice.Webhook("example-webhook", {
    active: true,
    displayName: "webhook example",
    organizationName: "example",
    payloadUrl: "https://example.com/webhook",
});

    import pulumi
import pulumi_pulumiservice
webhook = pulumi_pulumiservice.Webhook("example-webhook",
    active=True,
    display_name="webhook example",
    organization_name="example",
    payload_url="https://example.com/webhook",
)

    import (
	"fmt"
	"github.com/pulumi/pulumi-pulumiservice/sdk/go/pulumiservice"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		webhook, err := pulumiservice.NewWebhook(ctx, "example-webhook", &pulumiservice.WebhookArgs{
			Active:           pulumi.Bool(true),
			DisplayName:      pulumi.String("webhook example"),
			OrganizationName: pulumi.String("example"),
			PayloadURL:       pulumi.String("https://example.com/webhook"),
		}, nil)
		if err != nil {
			return fmt.Errorf("error creating webhook: %v", err)
		}
		return nil
	})
}

    using Pulumi;
using Pulumi.PulumiService;
class PulumiServiceWebhook: Stack
{
    public PulumiServiceWebhook()
    {
        var webhook = new Webhook("example-webhook", new WebhookArgs{
            Active = true,
            DisplayName = "webhook example",
            OrganizationName = "example",
            PayloadUrl = "https://example.com/webhook"
        });
    }
}

    import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.pulumiservice.Webhook;
import com.pulumi.pulumiservice.WebhookArgs;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    private static void stack(Context ctx) {
        var webhook = new Webhook("example-webhook", WebhookArgs.builder()
            .active(true)
            .displayName("webhook example")
            .organizationName("example")
            .payloadUrl("https://example.com/webhook")
            .build());
    }
}

    resources:
  webhook:
    type: pulumiservice:index:Webhook
    properties:
      active: true
      displayName: webhook example
      organizationName: example
      payloadUrl: https://example.com/webhook

    terraform {
  required_providers {
    pulumiservice = {
      source = "pulumi/pulumiservice"
    }
  }
}

resource "pulumiservice_webhook" "webhook" {
  active            = true
  display_name      = "webhook example"
  organization_name = "example"
  payload_url       = "https://example.com/webhook"
}

    Configuration

    To provision resources with the Pulumi Service provider, you need Pulumi Cloud credentials. The provider looks for an access token in this order:

    1. The pulumiservice:accessToken configuration option.
    2. The PULUMI_ACCESS_TOKEN environment variable.
    3. The account you’re logged in to with pulumi login.

    If you’ve already run pulumi login, you don’t need to configure anything else.

    The provider gets your login’s API URL from the Pulumi CLI, which passes it to providers starting with CLI v3.247.0. If you’re logged in to a self-hosted Pulumi Cloud with an older CLI, the provider calls https://api.pulumi.com instead, so also set PULUMI_BACKEND_URL or the apiUrl option, or upgrade the CLI.

    Use pulumi config set pulumiservice:<option> or pass options to the provider constructor.

    NameRequiredSecretDescription
    accessTokenNoYesPulumi Cloud access token. Defaults to PULUMI_ACCESS_TOKEN, then to your pulumi login credentials.
    apiUrlNoNoOverrides the default Pulumi Cloud API URL for self-hosted customers. Defaults to PULUMI_BACKEND_URL, then PULUMI_API, then https://api.pulumi.com.

    Example

    # Not needed if you've run `pulumi login` or set PULUMI_ACCESS_TOKEN.
pulumi config set --secret pulumiservice:accessToken <PULUMI_ACCESS_TOKEN>

# Only needed for a self-hosted Pulumi Cloud, and only if you haven't set
# PULUMI_BACKEND_URL or logged in to it with Pulumi CLI v3.247.0 or later.
pulumi config set pulumiservice:apiUrl <PULUMI_API_URL>
    pulumiservice logo pulumiservice logo
    Viewing docs for Pulumi Cloud v1.5.0
    published on Monday, Oct 19, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial