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

buildkite.Organization.getPortal

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

    Use this data source to retrieve a portal by slug. You can find out more about portals in the Buildkite documentation.

    Example Usage

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

const viewer = buildkite.Organization.getPortal({
    slug: "viewer-info",
});

    import pulumi
import pulumi_buildkite as buildkite

viewer = buildkite.Organization.get_portal(slug="viewer-info")

    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 {
		_, err := organization.GetPortal(ctx, &organization.GetPortalArgs{
			Slug: "viewer-info",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var viewer = Buildkite.Organization.GetPortal.Invoke(new()
    {
        Slug = "viewer-info",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.buildkite.Organization.OrganizationFunctions;
import com.pulumi.buildkite.Organization.inputs.GetPortalArgs;
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) {
        final var viewer = OrganizationFunctions.getPortal(GetPortalArgs.builder()
            .slug("viewer-info")
            .build());

    }
}

    variables:
  viewer:
    fn::invoke:
      function: buildkite:Organization:getPortal
      arguments:
        slug: viewer-info

    Using getPortal

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPortal(args: GetPortalArgs, opts?: InvokeOptions): Promise<GetPortalResult>
function getPortalOutput(args: GetPortalOutputArgs, opts?: InvokeOptions): Output<GetPortalResult>
    def get_portal(slug: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetPortalResult
def get_portal_output(slug: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetPortalResult]
    func LookupPortal(ctx *Context, args *LookupPortalArgs, opts ...InvokeOption) (*LookupPortalResult, error)
func LookupPortalOutput(ctx *Context, args *LookupPortalOutputArgs, opts ...InvokeOption) LookupPortalResultOutput

    > Note: This function is named LookupPortal in the Go SDK.

    public static class GetPortal 
{
    public static Task<GetPortalResult> InvokeAsync(GetPortalArgs args, InvokeOptions? opts = null)
    public static Output<GetPortalResult> Invoke(GetPortalInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)
public static Output<GetPortalResult> getPortal(GetPortalArgs args, InvokeOptions options)

    fn::invoke:
  function: buildkite:Organization/getPortal:getPortal
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Slug string
    The slug of the portal to retrieve.
    Slug string
    The slug of the portal to retrieve.
    slug String
    The slug of the portal to retrieve.
    slug string
    The slug of the portal to retrieve.
    slug str
    The slug of the portal to retrieve.
    slug String
    The slug of the portal to retrieve.

    getPortal Result

    The following output properties are available:

    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    CreatedAt string
    The time when the portal was created.
    CreatedBy Pulumiverse.Buildkite.Organization.Outputs.GetPortalCreatedBy
    Information about the user who created the portal.
    Description string
    The description of the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal to retrieve.
    UserInvokable bool
    Whether users can invoke the portal.
    Uuid string
    The UUID of the portal.
    AllowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    CreatedAt string
    The time when the portal was created.
    CreatedBy GetPortalCreatedBy
    Information about the user who created the portal.
    Description string
    The description of the portal.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The name of the portal.
    Query string
    The GraphQL query that the portal executes.
    Slug string
    The slug of the portal to retrieve.
    UserInvokable bool
    Whether users can invoke the portal.
    Uuid string
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt String
    The time when the portal was created.
    createdBy GetPortalCreatedBy
    Information about the user who created the portal.
    description String
    The description of the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal to retrieve.
    userInvokable Boolean
    Whether users can invoke the portal.
    uuid String
    The UUID of the portal.
    allowedIpAddresses string
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt string
    The time when the portal was created.
    createdBy GetPortalCreatedBy
    Information about the user who created the portal.
    description string
    The description of the portal.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The name of the portal.
    query string
    The GraphQL query that the portal executes.
    slug string
    The slug of the portal to retrieve.
    userInvokable boolean
    Whether users can invoke the portal.
    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.
    created_at str
    The time when the portal was created.
    created_by GetPortalCreatedBy
    Information about the user who created the portal.
    description str
    The description of the portal.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The name of the portal.
    query str
    The GraphQL query that the portal executes.
    slug str
    The slug of the portal to retrieve.
    user_invokable bool
    Whether users can invoke the portal.
    uuid str
    The UUID of the portal.
    allowedIpAddresses String
    Space-delimited list of IP addresses (in CIDR notation) allowed to invoke this portal.
    createdAt String
    The time when the portal was created.
    createdBy Property Map
    Information about the user who created the portal.
    description String
    The description of the portal.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The name of the portal.
    query String
    The GraphQL query that the portal executes.
    slug String
    The slug of the portal to retrieve.
    userInvokable Boolean
    Whether users can invoke the portal.
    uuid String
    The UUID of the portal.

    Supporting Types

    GetPortalCreatedBy

    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.

    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.