1. Packages
  2. Buildkite
  3. API Docs
  4. Organization
  5. Portal
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

buildkite.Organization.Portal

buildkite logo
Viewing docs for Buildkite v3.2.0
published on Monday, Feb 23, 2026 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-buildkite

    This resource allows you to manage portals in Buildkite. Portals allow you to expose GraphQL queries that can be invoked via a REST API endpoint. Find out more information in our documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as buildkite from "@pulumiverse/buildkite";

// minimal portal
const viewer = new buildkite.organization.Portal("viewer", {
    slug: "viewer-info",
    name: "Viewer Information",
    query: "{ viewer { user { name email } } }",
});
// portal with all optional fields
const restricted = new buildkite.organization.Portal("restricted", {
    slug: "restricted-portal",
    name: "Restricted Portal",
    description: "Portal with IP restrictions and custom settings",
    query: "{ viewer { user { name email avatar { url } } } }",
    userInvokable: true,
    allowedIpAddresses: "192.168.1.0/24 10.0.0.0/8",
});
// portal with complex GraphQL query
const pipelineStats = new buildkite.organization.Portal("pipeline_stats", {
    slug: "pipeline-statistics",
    name: "Pipeline Statistics",
    description: "Returns statistics for organization pipelines",
    query: `{
  organization(slug: \\"my-org\\") {
    pipelines(first: 10) {
      edges {
        node {
          name
          slug
          builds(first: 5) {
            edges {
              node {
                number
                state
                createdAt
              }
            }
          }
        }
      }
    }
  }
}
`,
    userInvokable: false,
});

    import pulumi
import pulumiverse_buildkite as buildkite

# minimal portal
viewer = buildkite.organization.Portal("viewer",
    slug="viewer-info",
    name="Viewer Information",
    query="{ viewer { user { name email } } }")
# portal with all optional fields
restricted = buildkite.organization.Portal("restricted",
    slug="restricted-portal",
    name="Restricted Portal",
    description="Portal with IP restrictions and custom settings",
    query="{ viewer { user { name email avatar { url } } } }",
    user_invokable=True,
    allowed_ip_addresses="192.168.1.0/24 10.0.0.0/8")
# portal with complex GraphQL query
pipeline_stats = buildkite.organization.Portal("pipeline_stats",
    slug="pipeline-statistics",
    name="Pipeline Statistics",
    description="Returns statistics for organization pipelines",
    query="""{
  organization(slug: \"my-org\") {
    pipelines(first: 10) {
      edges {
        node {
          name
          slug
          builds(first: 5) {
            edges {
              node {
                number
                state
                createdAt
              }
            }
          }
        }
      }
    }
  }
}
""",
    user_invokable=False)

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-buildkite/sdk/v3/go/buildkite/organization"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// minimal portal
		_, err := organization.NewPortal(ctx, "viewer", &organization.PortalArgs{
			Slug:  pulumi.String("viewer-info"),
			Name:  pulumi.String("Viewer Information"),
			Query: pulumi.String("{ viewer { user { name email } } }"),
		})
		if err != nil {
			return err
		}
		// portal with all optional fields
		_, err = organization.NewPortal(ctx, "restricted", &organization.PortalArgs{
			Slug:               pulumi.String("restricted-portal"),
			Name:               pulumi.String("Restricted Portal"),
			Description:        pulumi.String("Portal with IP restrictions and custom settings"),
			Query:              pulumi.String("{ viewer { user { name email avatar { url } } } }"),
			UserInvokable:      pulumi.Bool(true),
			AllowedIpAddresses: pulumi.String("192.168.1.0/24 10.0.0.0/8"),
		})
		if err != nil {
			return err
		}
		// portal with complex GraphQL query
		_, err = organization.NewPortal(ctx, "pipeline_stats", &organization.PortalArgs{
			Slug:        pulumi.String("pipeline-statistics"),
			Name:        pulumi.String("Pipeline Statistics"),
			Description: pulumi.String("Returns statistics for organization pipelines"),
			Query: pulumi.String(`{
  organization(slug: \"my-org\") {
    pipelines(first: 10) {
      edges {
        node {
          name
          slug
          builds(first: 5) {
            edges {
              node {
                number
                state
                createdAt
              }
            }
          }
        }
      }
    }
  }
}
`),
			UserInvokable: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Buildkite = Pulumiverse.Buildkite;

return await Deployment.RunAsync(() => 
{
    // minimal portal
    var viewer = new Buildkite.Organization.Portal("viewer", new()
    {
        Slug = "viewer-info",
        Name = "Viewer Information",
        Query = "{ viewer { user { name email } } }",
    });

    // portal with all optional fields
    var restricted = new Buildkite.Organization.Portal("restricted", new()
    {
        Slug = "restricted-portal",
        Name = "Restricted Portal",
        Description = "Portal with IP restrictions and custom settings",
        Query = "{ viewer { user { name email avatar { url } } } }",
        UserInvokable = true,
        AllowedIpAddresses = "192.168.1.0/24 10.0.0.0/8",
    });

    // portal with complex GraphQL query
    var pipelineStats = new Buildkite.Organization.Portal("pipeline_stats", new()
    {
        Slug = "pipeline-statistics",
        Name = "Pipeline Statistics",
        Description = "Returns statistics for organization pipelines",
        Query = @"{
  organization(slug: \""my-org\"") {
    pipelines(first: 10) {
      edges {
        node {
          name
          slug
          builds(first: 5) {
            edges {
              node {
                number
                state
                createdAt
              }
            }
          }
        }
      }
    }
  }
}
",
        UserInvokable = false,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.Organization.Portal;
import com.pulumi.buildkite.Organization.PortalArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        // minimal portal
        var viewer = new Portal("viewer", PortalArgs.builder()
            .slug("viewer-info")
            .name("Viewer Information")
            .query("{ viewer { user { name email } } }")
            .build());

        // portal with all optional fields
        var restricted = new Portal("restricted", PortalArgs.builder()
            .slug("restricted-portal")
            .name("Restricted Portal")
            .description("Portal with IP restrictions and custom settings")
            .query("{ viewer { user { name email avatar { url } } } }")
            .userInvokable(true)
            .allowedIpAddresses("192.168.1.0/24 10.0.0.0/8")
            .build());

        // portal with complex GraphQL query
        var pipelineStats = new Portal("pipelineStats", PortalArgs.builder()
            .slug("pipeline-statistics")
            .name("Pipeline Statistics")
            .description("Returns statistics for organization pipelines")
            .query("""
{
  organization(slug: \"my-org\") {
    pipelines(first: 10) {
      edges {
        node {
          name
          slug
          builds(first: 5) {
            edges {
              node {
                number
                state
                createdAt
              }
            }
          }
        }
      }
    }
  }
}
            """)
            .userInvokable(false)
            .build());

    }
}

    resources:
  # minimal portal
  viewer:
    type: buildkite:Organization:Portal
    properties:
      slug: viewer-info
      name: Viewer Information
      query: '{ viewer { user { name email } } }'
  # portal with all optional fields
  restricted:
    type: buildkite:Organization:Portal
    properties:
      slug: restricted-portal
      name: Restricted Portal
      description: Portal with IP restrictions and custom settings
      query: '{ viewer { user { name email avatar { url } } } }'
      userInvokable: true
      allowedIpAddresses: 192.168.1.0/24 10.0.0.0/8
  # portal with complex GraphQL query
  pipelineStats:
    type: buildkite:Organization:Portal
    name: pipeline_stats
    properties:
      slug: pipeline-statistics
      name: Pipeline Statistics
      description: Returns statistics for organization pipelines
      query: |
        {
          organization(slug: \"my-org\") {
            pipelines(first: 10) {
              edges {
                node {
                  name
                  slug
                  builds(first: 5) {
                    edges {
                      node {
                        number
                        state
                        createdAt
                      }
                    }
                  }
                }
              }
            }
          }
        }
      userInvokable: false

    Create Portal Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Portal(name: string, args: PortalArgs, opts?: CustomResourceOptions);
    @overload
def Portal(resource_name: str,
           args: PortalArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Portal(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           query: Optional[str] = None,
           slug: Optional[str] = None,
           allowed_ip_addresses: Optional[str] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           user_invokable: Optional[bool] = None)
    func NewPortal(ctx *Context, name string, args PortalArgs, opts ...ResourceOption) (*Portal, error)
    public Portal(string name, PortalArgs args, CustomResourceOptions? opts = null)
    public Portal(String name, PortalArgs args)
public Portal(String name, PortalArgs args, CustomResourceOptions options)

    type: buildkite:Organization:Portal
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PortalArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var portalResource = new Buildkite.Organization.Portal("portalResource", new()
{
    Query = "string",
    Slug = "string",
    AllowedIpAddresses = "string",
    Description = "string",
    Name = "string",
    UserInvokable = false,
});

    example, err := organization.NewPortal(ctx, "portalResource", &organization.PortalArgs{
	Query:              pulumi.String("string"),
	Slug:               pulumi.String("string"),
	AllowedIpAddresses: pulumi.String("string"),
	Description:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	UserInvokable:      pulumi.Bool(false),
})

    var portalResource = new Portal("portalResource", PortalArgs.builder()
    .query("string")
    .slug("string")
    .allowedIpAddresses("string")
    .description("string")
    .name("string")
    .userInvokable(false)
    .build());

    portal_resource = buildkite.organization.Portal("portalResource",
    query="string",
    slug="string",
    allowed_ip_addresses="string",
    description="string",
    name="string",
    user_invokable=False)

    const portalResource = new buildkite.organization.Portal("portalResource", {
    query: "string",
    slug: "string",
    allowedIpAddresses: "string",
    description: "string",
    name: "string",
    userInvokable: false,
});

    type: buildkite:Organization:Portal
properties:
    allowedIpAddresses: string
    description: string
    name: string
    query: string
    slug: string
    userInvokable: false

    Portal Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Portal resource accepts the following input properties:

    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal. Used in the portal's URL path.
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    Description string
    A description of the portal.
    Name string
    The name of the portal.
    UserInvokable bool
    Whether users can invoke the portal. Defaults to false.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal. Used in the portal's URL path.
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    Description string
    A description of the portal.
    Name string
    The name of the portal.
    UserInvokable bool
    Whether users can invoke the portal. Defaults to false.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal. Used in the portal's URL path.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    description String
    A description of the portal.
    name String
    The name of the portal.
    userInvokable Boolean
    Whether users can invoke the portal. Defaults to false.
    query string
    The GraphQL query that the portal executes.
    slug string
    The slug of the portal. Used in the portal's URL path.
    allowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    description string
    A description of the portal.
    name string
    The name of the portal.
    userInvokable boolean
    Whether users can invoke the portal. Defaults to false.
    query str
    The GraphQL query that the portal executes.
    slug str
    The slug of the portal. Used in the portal's URL path.
    allowed_ip_addresses str
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    description str
    A description of the portal.
    name str
    The name of the portal.
    user_invokable bool
    Whether users can invoke the portal. Defaults to false.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal. Used in the portal's URL path.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    description String
    A description of the portal.
    name String
    The name of the portal.
    userInvokable Boolean
    Whether users can invoke the portal. Defaults to false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Portal resource produces the following output properties:

    CreatedAt string
    The time when the portal was created.
    CreatedBy Pulumiverse.Buildkite.Organization.Outputs.PortalCreatedBy
    Information about the user who created the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token used to invoke the portal. Only returned on creation.
    Uuid string
    The UUID of the portal.
    CreatedAt string
    The time when the portal was created.
    CreatedBy PortalCreatedBy
    Information about the user who created the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The token used to invoke the portal. Only returned on creation.
    Uuid string
    The UUID of the portal.
    createdAt String
    The time when the portal was created.
    createdBy PortalCreatedBy
    Information about the user who created the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token used to invoke the portal. Only returned on creation.
    uuid String
    The UUID of the portal.
    createdAt string
    The time when the portal was created.
    createdBy PortalCreatedBy
    Information about the user who created the portal.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The token used to invoke the portal. Only returned on creation.
    uuid string
    The UUID of the portal.
    created_at str
    The time when the portal was created.
    created_by PortalCreatedBy
    Information about the user who created the portal.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The token used to invoke the portal. Only returned on creation.
    uuid str
    The UUID of the portal.
    createdAt String
    The time when the portal was created.
    createdBy Property Map
    Information about the user who created the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The token used to invoke the portal. Only returned on creation.
    uuid String
    The UUID of the portal.

    Look up Existing Portal Resource

    Get an existing Portal resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: PortalState, opts?: CustomResourceOptions): Portal
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_ip_addresses: Optional[str] = None,
        created_at: Optional[str] = None,
        created_by: Optional[PortalCreatedByArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        query: Optional[str] = None,
        slug: Optional[str] = None,
        token: Optional[str] = None,
        user_invokable: Optional[bool] = None,
        uuid: Optional[str] = None) -> Portal
    func GetPortal(ctx *Context, name string, id IDInput, state *PortalState, opts ...ResourceOption) (*Portal, error)
    public static Portal Get(string name, Input<string> id, PortalState? state, CustomResourceOptions? opts = null)
    public static Portal get(String name, Output<String> id, PortalState state, CustomResourceOptions options)
    resources:  _:    type: buildkite:Organization:Portal    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    CreatedAt string
    The time when the portal was created.
    CreatedBy Pulumiverse.Buildkite.Organization.Inputs.PortalCreatedBy
    Information about the user who created the portal.
    Description string
    A description of the portal.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal. Used in the portal's URL path.
    Token string
    The token used to invoke the portal. Only returned on creation.
    UserInvokable bool
    Whether users can invoke the portal. Defaults to false.
    Uuid string
    The UUID of the portal.
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    CreatedAt string
    The time when the portal was created.
    CreatedBy PortalCreatedByArgs
    Information about the user who created the portal.
    Description string
    A description of the portal.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal. Used in the portal's URL path.
    Token string
    The token used to invoke the portal. Only returned on creation.
    UserInvokable bool
    Whether users can invoke the portal. Defaults to false.
    Uuid string
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    createdAt String
    The time when the portal was created.
    createdBy PortalCreatedBy
    Information about the user who created the portal.
    description String
    A description of the portal.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal. Used in the portal's URL path.
    token String
    The token used to invoke the portal. Only returned on creation.
    userInvokable Boolean
    Whether users can invoke the portal. Defaults to false.
    uuid String
    The UUID of the portal.
    allowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    createdAt string
    The time when the portal was created.
    createdBy PortalCreatedBy
    Information about the user who created the portal.
    description string
    A description of the portal.
    name string
    The name of the portal.
    query string
    The GraphQL query that the portal executes.
    slug string
    The slug of the portal. Used in the portal's URL path.
    token string
    The token used to invoke the portal. Only returned on creation.
    userInvokable boolean
    Whether users can invoke the portal. Defaults to false.
    uuid string
    The UUID of the portal.
    allowed_ip_addresses str
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    created_at str
    The time when the portal was created.
    created_by PortalCreatedByArgs
    Information about the user who created the portal.
    description str
    A description of the portal.
    name str
    The name of the portal.
    query str
    The GraphQL query that the portal executes.
    slug str
    The slug of the portal. Used in the portal's URL path.
    token str
    The token used to invoke the portal. Only returned on creation.
    user_invokable bool
    Whether users can invoke the portal. Defaults to false.
    uuid str
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal. If not specified, all IP addresses are allowed.
    createdAt String
    The time when the portal was created.
    createdBy Property Map
    Information about the user who created the portal.
    description String
    A description of the portal.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal. Used in the portal's URL path.
    token String
    The token used to invoke the portal. Only returned on creation.
    userInvokable Boolean
    Whether users can invoke the portal. Defaults to false.
    uuid String
    The UUID of the portal.

    Supporting Types

    PortalCreatedBy, PortalCreatedByArgs

    Email string
    The email of the user.
    Name string
    The name of the user.
    Uuid string
    The UUID of the user.
    Email string
    The email of the user.
    Name string
    The name of the user.
    Uuid string
    The UUID of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    uuid String
    The UUID of the user.
    email string
    The email of the user.
    name string
    The name of the user.
    uuid string
    The UUID of the user.
    email str
    The email of the user.
    name str
    The name of the user.
    uuid str
    The UUID of the user.
    email String
    The email of the user.
    name String
    The name of the user.
    uuid String
    The UUID of the user.

    Import

    Using pulumi import, import resources using the id. For example:

    import a portal resource using the portal slug

    you can find the slug from the Buildkite web UI in the portal’s URL:

    https://buildkite.com/organizations/{org}/portals/{slug}

    or by listing all portals via the REST API:

    GET https://api.buildkite.com/v2/organizations/{org}/portals

    $ pulumi import buildkite:Organization/portal:Portal viewer viewer-info

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    buildkite pulumiverse/pulumi-buildkite
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the buildkite Terraform Provider.
    buildkite logo
    Viewing docs for Buildkite v3.2.0
    published on Monday, Feb 23, 2026 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-buildkite
      Try Pulumi Cloud free. Your team will thank you.