1. Registry
  2. Packages
  3. DigitalOcean Provider
  4. API Docs
  5. getActionGatewayProviders
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 on the Action Gateway tool providers, with the ability to filter and sort the results. Use it to find a provider’s slug, the scopes it offers, and the connection parameters a digitalocean.ActionGatewayConnection needs. If no filters are specified, all providers are returned.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const jira = digitalocean.getActionGatewayProviders({
        filters: [{
            key: "name",
            values: ["jira"],
        }],
    });
    export const jiraParameters = jira.then(jira => jira.providers?.[0]?.connectionParameters.map(__item => __item.key));
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    jira = digitalocean.get_action_gateway_providers(filters=[{
        "key": "name",
        "values": ["jira"],
    }])
    pulumi.export("jiraParameters", [__item.key for __item in jira.providers[0].connection_parameters])
    
    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 {
    jira, err := digitalocean.GetActionGatewayProviders(ctx, &digitalocean.GetActionGatewayProvidersArgs{
    Filters: []digitalocean.GetActionGatewayProvidersFilter{
    {
    Key: "name",
    Values: []string{
    "jira",
    },
    },
    },
    }, nil);
    if err != nil {
    return err
    }
    ctx.Export("jiraParameters", pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:8,11-56)))
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var jira = DigitalOcean.GetActionGatewayProviders.Invoke(new()
        {
            Filters = new[]
            {
                new DigitalOcean.Inputs.GetActionGatewayProvidersFilterInputArgs
                {
                    Key = "name",
                    Values = new[]
                    {
                        "jira",
                    },
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["jiraParameters"] = jira.Apply(getActionGatewayProvidersResult => getActionGatewayProvidersResult.Providers[0]?.ConnectionParameters).Select(__item => __item.Key).ToList(),
        };
    });
    
    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.GetActionGatewayProvidersArgs;
    import com.pulumi.digitalocean.inputs.GetActionGatewayProvidersFilterArgs;
    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 jira = DigitaloceanFunctions.getActionGatewayProviders(GetActionGatewayProvidersArgs.builder()
                .filters(GetActionGatewayProvidersFilterArgs.builder()
                    .key("name")
                    .values("jira")
                    .build())
                .build());
    
            ctx.export("jiraParameters", jira.providers()[0].connectionParameters().stream().map(element -> element.key()).collect(toList()));
        }
    }
    
    Example coming soon!
    
    terraform {
      required_providers {
        digitalocean = {
          source = "pulumi/digitalocean"
        }
      }
    }
    
    data "digitalocean_action_gateway_providers" "jira" {
      filter {
        key    = "name"
        values = ["jira"]
      }
    }
    
    output "jiraParameters" {
      value = data.digitalocean_action_gateway_providers.jira.providers[0].connection_parameters[*].key
    }
    

    Using getActionGatewayProviders

    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 getActionGatewayProviders(args: GetActionGatewayProvidersArgs, opts?: InvokeOptions): Promise<GetActionGatewayProvidersResult>
    function getActionGatewayProvidersOutput(args: GetActionGatewayProvidersOutputArgs, opts?: InvokeOutputOptions): Output<GetActionGatewayProvidersResult>
    def get_action_gateway_providers(filters: Optional[Sequence[GetActionGatewayProvidersFilter]] = None,
                                     sorts: Optional[Sequence[GetActionGatewayProvidersSort]] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetActionGatewayProvidersResult
    def get_action_gateway_providers_output(filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetActionGatewayProvidersFilterArgs]]]] = None,
                                     sorts: pulumi.Input[Optional[Sequence[pulumi.Input[GetActionGatewayProvidersSortArgs]]]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetActionGatewayProvidersResult]
    func GetActionGatewayProviders(ctx *Context, args *GetActionGatewayProvidersArgs, opts ...InvokeOption) (*GetActionGatewayProvidersResult, error)
    func GetActionGatewayProvidersOutput(ctx *Context, args *GetActionGatewayProvidersOutputArgs, opts ...InvokeOption) GetActionGatewayProvidersResultOutput

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

    public static class GetActionGatewayProviders 
    {
        public static Task<GetActionGatewayProvidersResult> InvokeAsync(GetActionGatewayProvidersArgs args, InvokeOptions? opts = null)
        public static Output<GetActionGatewayProvidersResult> Invoke(GetActionGatewayProvidersInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetActionGatewayProvidersResult> Invoke(GetActionGatewayProvidersInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetActionGatewayProvidersResult> getActionGatewayProviders(GetActionGatewayProvidersArgs args, InvokeOptions options)
    public static Output<GetActionGatewayProvidersResult> getActionGatewayProviders(GetActionGatewayProvidersArgs args, InvokeOptions options)
    public static Output<GetActionGatewayProvidersResult> getActionGatewayProviders(GetActionGatewayProvidersArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: digitalocean:index/getActionGatewayProviders:getActionGatewayProviders
      arguments:
        # arguments dictionary
    data "digitalocean_get_action_gateway_providers" "name" {
        # arguments
    }

    The following arguments are supported:

    Filters List<Pulumi.DigitalOcean.Inputs.GetActionGatewayProvidersFilter>
    Filter the results. The filter block is documented below.
    Sorts List<Pulumi.DigitalOcean.Inputs.GetActionGatewayProvidersSort>
    Sort the results. The sort block is documented below.
    Filters []GetActionGatewayProvidersFilter
    Filter the results. The filter block is documented below.
    Sorts []GetActionGatewayProvidersSort
    Sort the results. The sort block is documented below.
    filters list(object)
    Filter the results. The filter block is documented below.
    sorts list(object)
    Sort the results. The sort block is documented below.
    filters List<GetActionGatewayProvidersFilter>
    Filter the results. The filter block is documented below.
    sorts List<GetActionGatewayProvidersSort>
    Sort the results. The sort block is documented below.
    filters GetActionGatewayProvidersFilter[]
    Filter the results. The filter block is documented below.
    sorts GetActionGatewayProvidersSort[]
    Sort the results. The sort block is documented below.
    filters Sequence[GetActionGatewayProvidersFilter]
    Filter the results. The filter block is documented below.
    sorts Sequence[GetActionGatewayProvidersSort]
    Sort the results. The sort block is documented below.
    filters List<Property Map>
    Filter the results. The filter block is documented below.
    sorts List<Property Map>
    Sort the results. The sort block is documented below.

    getActionGatewayProviders Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Providers List<Pulumi.DigitalOcean.Outputs.GetActionGatewayProvidersProvider>
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    Filters List<Pulumi.DigitalOcean.Outputs.GetActionGatewayProvidersFilter>
    Sorts List<Pulumi.DigitalOcean.Outputs.GetActionGatewayProvidersSort>
    Id string
    The provider-assigned unique ID for this managed resource.
    Providers []GetActionGatewayProvidersProvider
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    Filters []GetActionGatewayProvidersFilter
    Sorts []GetActionGatewayProvidersSort
    id string
    The provider-assigned unique ID for this managed resource.
    providers list(object)
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    filters list(object)
    sorts list(object)
    id String
    The provider-assigned unique ID for this managed resource.
    providers List<GetActionGatewayProvidersProvider>
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    filters List<GetActionGatewayProvidersFilter>
    sorts List<GetActionGatewayProvidersSort>
    id string
    The provider-assigned unique ID for this managed resource.
    providers GetActionGatewayProvidersProvider[]
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    filters GetActionGatewayProvidersFilter[]
    sorts GetActionGatewayProvidersSort[]
    id str
    The provider-assigned unique ID for this managed resource.
    providers Sequence[GetActionGatewayProvidersProvider]
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    filters Sequence[GetActionGatewayProvidersFilter]
    sorts Sequence[GetActionGatewayProvidersSort]
    id String
    The provider-assigned unique ID for this managed resource.
    providers List<Property Map>
    A list of tool providers satisfying any filter and sort criteria. Each provider has the following attributes:
    filters List<Property Map>
    sorts List<Property Map>

    Supporting Types

    GetActionGatewayProvidersFilter

    Key string
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    Values List<string>
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    Key string
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    Values []string
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    All bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    MatchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    values list(string)
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    values List<String>
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key string
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    values string[]
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    all boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy string
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key str
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    values Sequence[str]
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    all bool
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    match_by str
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.
    key String
    Filter the providers by this key. This may be one of name, displayName, description, authTypes, and scopes.
    values List<String>
    A list of values to match against the key field. Only retrieves providers where the key field takes on one or more of the values provided here.
    all Boolean
    Set to true to require that a field match all of the values instead of just one or more of them. This is useful when matching against multi-valued fields such as lists or sets where you want to ensure that all of the values are present in the list or set.
    matchBy String
    One of exact (default), re, or substring. For string-typed fields, specify re to match by using the values as regular expressions, or specify substring to match by treating the values as substrings to find within the string field.

    GetActionGatewayProvidersProvider

    AuthTypes List<string>
    The credential kinds the provider accepts.
    ConnectionParameters List<Pulumi.DigitalOcean.Inputs.GetActionGatewayProvidersProviderConnectionParameter>
    The parameters a connection to the provider accepts.
    Description string
    The parameter's description.
    DisplayName string
    The human-readable name of the provider.
    Name string
    The provider slug, used as toolProvider on connections.
    Scopes List<string>
    The OAuth scopes the provider offers.
    AuthTypes []string
    The credential kinds the provider accepts.
    ConnectionParameters []GetActionGatewayProvidersProviderConnectionParameter
    The parameters a connection to the provider accepts.
    Description string
    The parameter's description.
    DisplayName string
    The human-readable name of the provider.
    Name string
    The provider slug, used as toolProvider on connections.
    Scopes []string
    The OAuth scopes the provider offers.
    auth_types list(string)
    The credential kinds the provider accepts.
    connection_parameters list(object)
    The parameters a connection to the provider accepts.
    description string
    The parameter's description.
    display_name string
    The human-readable name of the provider.
    name string
    The provider slug, used as toolProvider on connections.
    scopes list(string)
    The OAuth scopes the provider offers.
    authTypes List<String>
    The credential kinds the provider accepts.
    connectionParameters List<GetActionGatewayProvidersProviderConnectionParameter>
    The parameters a connection to the provider accepts.
    description String
    The parameter's description.
    displayName String
    The human-readable name of the provider.
    name String
    The provider slug, used as toolProvider on connections.
    scopes List<String>
    The OAuth scopes the provider offers.
    authTypes string[]
    The credential kinds the provider accepts.
    connectionParameters GetActionGatewayProvidersProviderConnectionParameter[]
    The parameters a connection to the provider accepts.
    description string
    The parameter's description.
    displayName string
    The human-readable name of the provider.
    name string
    The provider slug, used as toolProvider on connections.
    scopes string[]
    The OAuth scopes the provider offers.
    auth_types Sequence[str]
    The credential kinds the provider accepts.
    connection_parameters Sequence[GetActionGatewayProvidersProviderConnectionParameter]
    The parameters a connection to the provider accepts.
    description str
    The parameter's description.
    display_name str
    The human-readable name of the provider.
    name str
    The provider slug, used as toolProvider on connections.
    scopes Sequence[str]
    The OAuth scopes the provider offers.
    authTypes List<String>
    The credential kinds the provider accepts.
    connectionParameters List<Property Map>
    The parameters a connection to the provider accepts.
    description String
    The parameter's description.
    displayName String
    The human-readable name of the provider.
    name String
    The provider slug, used as toolProvider on connections.
    scopes List<String>
    The OAuth scopes the provider offers.

    GetActionGatewayProvidersProviderConnectionParameter

    AllowedValues List<string>
    The values the parameter accepts, when restricted.
    Description string
    The parameter's description.
    InputKind string
    The kind of input the parameter takes.
    Key string
    The parameter's key in connectionParameters.
    Label string
    The parameter's label.
    Required bool
    Whether the parameter is required.
    AllowedValues []string
    The values the parameter accepts, when restricted.
    Description string
    The parameter's description.
    InputKind string
    The kind of input the parameter takes.
    Key string
    The parameter's key in connectionParameters.
    Label string
    The parameter's label.
    Required bool
    Whether the parameter is required.
    allowed_values list(string)
    The values the parameter accepts, when restricted.
    description string
    The parameter's description.
    input_kind string
    The kind of input the parameter takes.
    key string
    The parameter's key in connectionParameters.
    label string
    The parameter's label.
    required bool
    Whether the parameter is required.
    allowedValues List<String>
    The values the parameter accepts, when restricted.
    description String
    The parameter's description.
    inputKind String
    The kind of input the parameter takes.
    key String
    The parameter's key in connectionParameters.
    label String
    The parameter's label.
    required Boolean
    Whether the parameter is required.
    allowedValues string[]
    The values the parameter accepts, when restricted.
    description string
    The parameter's description.
    inputKind string
    The kind of input the parameter takes.
    key string
    The parameter's key in connectionParameters.
    label string
    The parameter's label.
    required boolean
    Whether the parameter is required.
    allowed_values Sequence[str]
    The values the parameter accepts, when restricted.
    description str
    The parameter's description.
    input_kind str
    The kind of input the parameter takes.
    key str
    The parameter's key in connectionParameters.
    label str
    The parameter's label.
    required bool
    Whether the parameter is required.
    allowedValues List<String>
    The values the parameter accepts, when restricted.
    description String
    The parameter's description.
    inputKind String
    The kind of input the parameter takes.
    key String
    The parameter's key in connectionParameters.
    label String
    The parameter's label.
    required Boolean
    Whether the parameter is required.

    GetActionGatewayProvidersSort

    Key string
    Sort the providers by this key. This may be one of name, displayName, and description.
    Direction string
    The sort direction. This may be either asc or desc.
    Key string
    Sort the providers by this key. This may be one of name, displayName, and description.
    Direction string
    The sort direction. This may be either asc or desc.
    key string
    Sort the providers by this key. This may be one of name, displayName, and description.
    direction string
    The sort direction. This may be either asc or desc.
    key String
    Sort the providers by this key. This may be one of name, displayName, and description.
    direction String
    The sort direction. This may be either asc or desc.
    key string
    Sort the providers by this key. This may be one of name, displayName, and description.
    direction string
    The sort direction. This may be either asc or desc.
    key str
    Sort the providers by this key. This may be one of name, displayName, and description.
    direction str
    The sort direction. This may be either asc or desc.
    key String
    Sort the providers by this key. This may be one of name, displayName, and description.
    direction String
    The sort direction. This may be either asc or desc.

    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