1. Registry
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getActionGatewayConnection
Viewing docs for DigitalOcean v4.85.0
published on Saturday, Nov 7, 2026 by Pulumi
digitalocean logo
Viewing docs for DigitalOcean v4.85.0
published on Saturday, Nov 7, 2026 by Pulumi

    Get information about an Action Gateway connection, such as one created in the control panel. Look a connection up by its id, or by its toolProvider and userId.

    The lookup finds only connections visible to the DigitalOcean user who owns Terraform’s API token. Revoked connections are never returned.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const github = digitalocean.getActionGatewayConnection({
        toolProvider: "github",
        userId: "user-123",
    });
    export const githubConnectionStatus = github.then(github => github.status);
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    github = digitalocean.get_action_gateway_connection(tool_provider="github",
        user_id="user-123")
    pulumi.export("githubConnectionStatus", github.status)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		github, err := digitalocean.GetActionGatewayConnection(ctx, &digitalocean.LookupActionGatewayConnectionArgs{
    			ToolProvider: pulumi.StringRef("github"),
    			UserId:       pulumi.StringRef("user-123"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("githubConnectionStatus", github.Status)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var github = DigitalOcean.GetActionGatewayConnection.Invoke(new()
        {
            ToolProvider = "github",
            UserId = "user-123",
        });
    
        return new Dictionary<string, object?>
        {
            ["githubConnectionStatus"] = github.Apply(getActionGatewayConnectionResult => getActionGatewayConnectionResult.Status),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetActionGatewayConnectionArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 github = DigitaloceanFunctions.getActionGatewayConnection(GetActionGatewayConnectionArgs.builder()
                .toolProvider("github")
                .userId("user-123")
                .build());
    
            ctx.export("githubConnectionStatus", github.status());
        }
    }
    
    variables:
      github:
        fn::invoke:
          function: digitalocean:getActionGatewayConnection
          arguments:
            toolProvider: github
            userId: user-123
    outputs:
      githubConnectionStatus: ${github.status}
    
    terraform {
      required_providers {
        digitalocean = {
          source = "pulumi/digitalocean"
        }
      }
    }
    
    data "digitalocean_action_gateway_connection" "github" {
      tool_provider = "github"
      user_id       = "user-123"
    }
    
    output "githubConnectionStatus" {
      value = data.digitalocean_action_gateway_connection.github.status
    }
    

    Using getActionGatewayConnection

    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 getActionGatewayConnection(args: GetActionGatewayConnectionArgs, opts?: InvokeOptions): Promise<GetActionGatewayConnectionResult>
    function getActionGatewayConnectionOutput(args: GetActionGatewayConnectionOutputArgs, opts?: InvokeOutputOptions): Output<GetActionGatewayConnectionResult>
    def get_action_gateway_connection(id: Optional[str] = None,
                                      tool_provider: Optional[str] = None,
                                      user_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetActionGatewayConnectionResult
    def get_action_gateway_connection_output(id: pulumi.Input[Optional[str]] = None,
                                      tool_provider: pulumi.Input[Optional[str]] = None,
                                      user_id: pulumi.Input[Optional[str]] = None,
                                      opts: Optional[InvokeOutputOptions] = None) -> Output[GetActionGatewayConnectionResult]
    func LookupActionGatewayConnection(ctx *Context, args *LookupActionGatewayConnectionArgs, opts ...InvokeOption) (*LookupActionGatewayConnectionResult, error)
    func LookupActionGatewayConnectionOutput(ctx *Context, args *LookupActionGatewayConnectionOutputArgs, opts ...InvokeOption) LookupActionGatewayConnectionResultOutput

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

    public static class GetActionGatewayConnection 
    {
        public static Task<GetActionGatewayConnectionResult> InvokeAsync(GetActionGatewayConnectionArgs args, InvokeOptions? opts = null)
        public static Output<GetActionGatewayConnectionResult> Invoke(GetActionGatewayConnectionInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetActionGatewayConnectionResult> Invoke(GetActionGatewayConnectionInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetActionGatewayConnectionResult> getActionGatewayConnection(GetActionGatewayConnectionArgs args, InvokeOptions options)
    public static Output<GetActionGatewayConnectionResult> getActionGatewayConnection(GetActionGatewayConnectionArgs args, InvokeOptions options)
    public static Output<GetActionGatewayConnectionResult> getActionGatewayConnection(GetActionGatewayConnectionArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: digitalocean:index/getActionGatewayConnection:getActionGatewayConnection
      arguments:
        # arguments dictionary
    data "digitalocean_get_action_gateway_connection" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    The ID of the connection.
    ToolProvider string
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    UserId string
    The actor ID the connection acts for.
    Id string
    The ID of the connection.
    ToolProvider string
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    UserId string
    The actor ID the connection acts for.
    id string
    The ID of the connection.
    tool_provider string
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    user_id string
    The actor ID the connection acts for.
    id String
    The ID of the connection.
    toolProvider String
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    userId String
    The actor ID the connection acts for.
    id string
    The ID of the connection.
    toolProvider string
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    userId string
    The actor ID the connection acts for.
    id str
    The ID of the connection.
    tool_provider str
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    user_id str
    The actor ID the connection acts for.
    id String
    The ID of the connection.
    toolProvider String
    and userId - (Optional) The slug of the connection's tool provider and the actor ID it acts for. Both must be set, and userId must match exactly.
    userId String
    The actor ID the connection acts for.

    getActionGatewayConnection Result

    The following output properties are available:

    Authorizations List<Pulumi.DigitalOcean.Outputs.GetActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    ConnectionParameters Dictionary<string, string>
    The provider's connection parameters.
    CreatedAt string
    When the connection was created.
    CredentialId string
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    Id string
    The ID of the connection.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Scopes List<string>
    The OAuth scopes granted, or requested while pending.
    Status string
    The status of the authorization.
    ToolProvider string
    The slug of the tool provider.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    UserId string
    The actor ID the connection acts for.
    Vpcs List<Pulumi.DigitalOcean.Outputs.GetActionGatewayConnectionVpc>
    The private network the connection's calls use, when configured.
    Authorizations []GetActionGatewayConnectionAuthorization
    The authorization the account holder still has to complete. Set only while the connection is pending.
    ConnectionParameters map[string]string
    The provider's connection parameters.
    CreatedAt string
    When the connection was created.
    CredentialId string
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    CredentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    GrantedAt string
    When the account holder completed authorization.
    Id string
    The ID of the connection.
    OwningUserId string
    The DigitalOcean user ID of the user who created the connection.
    Scopes []string
    The OAuth scopes granted, or requested while pending.
    Status string
    The status of the authorization.
    ToolProvider string
    The slug of the tool provider.
    ToolProviderDisplayName string
    The human-readable name of the tool provider.
    UpdatedAt string
    When the connection was last modified.
    UserId string
    The actor ID the connection acts for.
    Vpcs []GetActionGatewayConnectionVpc
    The private network the connection's calls use, when configured.
    authorizations list(object)
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connection_parameters map(string)
    The provider's connection parameters.
    created_at string
    When the connection was created.
    credential_id string
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    credential_kind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at string
    When the account holder completed authorization.
    id string
    The ID of the connection.
    owning_user_id string
    The DigitalOcean user ID of the user who created the connection.
    scopes list(string)
    The OAuth scopes granted, or requested while pending.
    status string
    The status of the authorization.
    tool_provider string
    The slug of the tool provider.
    tool_provider_display_name string
    The human-readable name of the tool provider.
    updated_at string
    When the connection was last modified.
    user_id string
    The actor ID the connection acts for.
    vpcs list(object)
    The private network the connection's calls use, when configured.
    authorizations List<GetActionGatewayConnectionAuthorization>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters Map<String,String>
    The provider's connection parameters.
    createdAt String
    When the connection was created.
    credentialId String
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    id String
    The ID of the connection.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    scopes List<String>
    The OAuth scopes granted, or requested while pending.
    status String
    The status of the authorization.
    toolProvider String
    The slug of the tool provider.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.
    userId String
    The actor ID the connection acts for.
    vpcs List<GetActionGatewayConnectionVpc>
    The private network the connection's calls use, when configured.
    authorizations GetActionGatewayConnectionAuthorization[]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters {[key: string]: string}
    The provider's connection parameters.
    createdAt string
    When the connection was created.
    credentialId string
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    credentialKind string
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt string
    When the account holder completed authorization.
    id string
    The ID of the connection.
    owningUserId string
    The DigitalOcean user ID of the user who created the connection.
    scopes string[]
    The OAuth scopes granted, or requested while pending.
    status string
    The status of the authorization.
    toolProvider string
    The slug of the tool provider.
    toolProviderDisplayName string
    The human-readable name of the tool provider.
    updatedAt string
    When the connection was last modified.
    userId string
    The actor ID the connection acts for.
    vpcs GetActionGatewayConnectionVpc[]
    The private network the connection's calls use, when configured.
    authorizations Sequence[GetActionGatewayConnectionAuthorization]
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connection_parameters Mapping[str, str]
    The provider's connection parameters.
    created_at str
    When the connection was created.
    credential_id str
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    credential_kind str
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    granted_at str
    When the account holder completed authorization.
    id str
    The ID of the connection.
    owning_user_id str
    The DigitalOcean user ID of the user who created the connection.
    scopes Sequence[str]
    The OAuth scopes granted, or requested while pending.
    status str
    The status of the authorization.
    tool_provider str
    The slug of the tool provider.
    tool_provider_display_name str
    The human-readable name of the tool provider.
    updated_at str
    When the connection was last modified.
    user_id str
    The actor ID the connection acts for.
    vpcs Sequence[GetActionGatewayConnectionVpc]
    The private network the connection's calls use, when configured.
    authorizations List<Property Map>
    The authorization the account holder still has to complete. Set only while the connection is pending.
    connectionParameters Map<String>
    The provider's connection parameters.
    createdAt String
    When the connection was created.
    credentialId String
    The ID of the team provider credential the connection uses, empty for digitaloceanOauth.
    credentialKind String
    The kind of credential the connection uses: digitaloceanOauth, privateOauth, or teamApiKey.
    grantedAt String
    When the account holder completed authorization.
    id String
    The ID of the connection.
    owningUserId String
    The DigitalOcean user ID of the user who created the connection.
    scopes List<String>
    The OAuth scopes granted, or requested while pending.
    status String
    The status of the authorization.
    toolProvider String
    The slug of the tool provider.
    toolProviderDisplayName String
    The human-readable name of the tool provider.
    updatedAt String
    When the connection was last modified.
    userId String
    The actor ID the connection acts for.
    vpcs List<Property Map>
    The private network the connection's calls use, when configured.

    Supporting Types

    GetActionGatewayConnectionAuthorization

    ConnectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider.
    ExpiresAt string
    When the authorization link expires.
    Status string
    The status of the authorization.
    VerificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    ConnectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider.
    ExpiresAt string
    When the authorization link expires.
    Status string
    The status of the authorization.
    VerificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    connect_url string
    (Sensitive) The URL the account holder opens to authorize the provider.
    expires_at string
    When the authorization link expires.
    status string
    The status of the authorization.
    verification_code string
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl String
    (Sensitive) The URL the account holder opens to authorize the provider.
    expiresAt String
    When the authorization link expires.
    status String
    The status of the authorization.
    verificationCode String
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl string
    (Sensitive) The URL the account holder opens to authorize the provider.
    expiresAt string
    When the authorization link expires.
    status string
    The status of the authorization.
    verificationCode string
    (Sensitive) The code the account holder confirms during authorization.
    connect_url str
    (Sensitive) The URL the account holder opens to authorize the provider.
    expires_at str
    When the authorization link expires.
    status str
    The status of the authorization.
    verification_code str
    (Sensitive) The code the account holder confirms during authorization.
    connectUrl String
    (Sensitive) The URL the account holder opens to authorize the provider.
    expiresAt String
    When the authorization link expires.
    status String
    The status of the authorization.
    verificationCode String
    (Sensitive) The code the account holder confirms during authorization.

    GetActionGatewayConnectionVpc

    Destinations List<Pulumi.DigitalOcean.Inputs.GetActionGatewayConnectionVpcDestination>
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    Region string
    The region of the VPC.
    VpcUuid string
    The UUID of the VPC.
    Destinations []GetActionGatewayConnectionVpcDestination
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    Region string
    The region of the VPC.
    VpcUuid string
    The UUID of the VPC.
    destinations list(object)
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    region string
    The region of the VPC.
    vpc_uuid string
    The UUID of the VPC.
    destinations List<GetActionGatewayConnectionVpcDestination>
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    region String
    The region of the VPC.
    vpcUuid String
    The UUID of the VPC.
    destinations GetActionGatewayConnectionVpcDestination[]
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    region string
    The region of the VPC.
    vpcUuid string
    The UUID of the VPC.
    destinations Sequence[GetActionGatewayConnectionVpcDestination]
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    region str
    The region of the VPC.
    vpc_uuid str
    The UUID of the VPC.
    destinations List<Property Map>
    The private hosts the connection's calls may reach, each with host, port, and allowedIpCidrs.
    region String
    The region of the VPC.
    vpcUuid String
    The UUID of the VPC.

    GetActionGatewayConnectionVpcDestination

    AllowedIpCidrs List<string>
    CIDR ranges that every address the host resolves to must fall within
    Host string
    Host name or IP address that resolves only to private addresses
    Port int
    Destination port
    AllowedIpCidrs []string
    CIDR ranges that every address the host resolves to must fall within
    Host string
    Host name or IP address that resolves only to private addresses
    Port int
    Destination port
    allowed_ip_cidrs list(string)
    CIDR ranges that every address the host resolves to must fall within
    host string
    Host name or IP address that resolves only to private addresses
    port number
    Destination port
    allowedIpCidrs List<String>
    CIDR ranges that every address the host resolves to must fall within
    host String
    Host name or IP address that resolves only to private addresses
    port Integer
    Destination port
    allowedIpCidrs string[]
    CIDR ranges that every address the host resolves to must fall within
    host string
    Host name or IP address that resolves only to private addresses
    port number
    Destination port
    allowed_ip_cidrs Sequence[str]
    CIDR ranges that every address the host resolves to must fall within
    host str
    Host name or IP address that resolves only to private addresses
    port int
    Destination port
    allowedIpCidrs List<String>
    CIDR ranges that every address the host resolves to must fall within
    host String
    Host name or IP address that resolves only to private addresses
    port Number
    Destination port

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    Viewing docs for DigitalOcean v4.85.0
    published on Saturday, Nov 7, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial