published on Wednesday, Jul 8, 2026 by Pulumi
published on Wednesday, Jul 8, 2026 by Pulumi
Caution: Preview Feature This feature is considered a preview feature in the provider, regardless of the state of the resource in Snowflake. We do not guarantee its stability. It will be reworked and marked as a stable feature in future releases. Breaking changes are expected, even without bumping the major version. To use this feature, add the relevant feature name to
previewFeaturesEnabledfield in the provider configuration. Please always refer to the Getting Help section in our Github repo to best determine how to get help for your questions.
Data source used to get details of filtered API integrations. Filtering is aligned with the current possibilities for SHOW API INTEGRATIONS query (only like is supported). The results of SHOW and DESCRIBE are encapsulated in one output collection apiIntegrations.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as snowflake from "@pulumi/snowflake";
// Simple usage
const simple = snowflake.getApiIntegrations({});
export const simpleOutput = simple.then(simple => simple.apiIntegrations);
// Filtering (like)
const like = snowflake.getApiIntegrations({
like: "api-integration-name",
});
export const likeOutput = like.then(like => like.apiIntegrations);
// Filtering by prefix (like)
const likePrefix = snowflake.getApiIntegrations({
like: "prefix%",
});
export const likePrefixOutput = likePrefix.then(likePrefix => likePrefix.apiIntegrations);
// Without additional data (to limit the number of calls made for every found API integration)
const onlyShow = snowflake.getApiIntegrations({
withDescribe: false,
});
export const onlyShowOutput = onlyShow.then(onlyShow => onlyShow.apiIntegrations);
import pulumi
import pulumi_snowflake as snowflake
# Simple usage
simple = snowflake.get_api_integrations()
pulumi.export("simpleOutput", simple.api_integrations)
# Filtering (like)
like = snowflake.get_api_integrations(like="api-integration-name")
pulumi.export("likeOutput", like.api_integrations)
# Filtering by prefix (like)
like_prefix = snowflake.get_api_integrations(like="prefix%")
pulumi.export("likePrefixOutput", like_prefix.api_integrations)
# Without additional data (to limit the number of calls made for every found API integration)
only_show = snowflake.get_api_integrations(with_describe=False)
pulumi.export("onlyShowOutput", only_show.api_integrations)
package main
import (
"github.com/pulumi/pulumi-snowflake/sdk/v2/go/snowflake"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// Simple usage
simple, err := snowflake.GetApiIntegrations(ctx, &snowflake.GetApiIntegrationsArgs{}, nil)
if err != nil {
return err
}
ctx.Export("simpleOutput", simple.ApiIntegrations)
// Filtering (like)
like, err := snowflake.GetApiIntegrations(ctx, &snowflake.GetApiIntegrationsArgs{
Like: pulumi.StringRef("api-integration-name"),
}, nil)
if err != nil {
return err
}
ctx.Export("likeOutput", like.ApiIntegrations)
// Filtering by prefix (like)
likePrefix, err := snowflake.GetApiIntegrations(ctx, &snowflake.GetApiIntegrationsArgs{
Like: pulumi.StringRef("prefix%"),
}, nil)
if err != nil {
return err
}
ctx.Export("likePrefixOutput", likePrefix.ApiIntegrations)
// Without additional data (to limit the number of calls made for every found API integration)
onlyShow, err := snowflake.GetApiIntegrations(ctx, &snowflake.GetApiIntegrationsArgs{
WithDescribe: pulumi.BoolRef(false),
}, nil)
if err != nil {
return err
}
ctx.Export("onlyShowOutput", onlyShow.ApiIntegrations)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Snowflake = Pulumi.Snowflake;
return await Deployment.RunAsync(() =>
{
// Simple usage
var simple = Snowflake.GetApiIntegrations.Invoke();
// Filtering (like)
var like = Snowflake.GetApiIntegrations.Invoke(new()
{
Like = "api-integration-name",
});
// Filtering by prefix (like)
var likePrefix = Snowflake.GetApiIntegrations.Invoke(new()
{
Like = "prefix%",
});
// Without additional data (to limit the number of calls made for every found API integration)
var onlyShow = Snowflake.GetApiIntegrations.Invoke(new()
{
WithDescribe = false,
});
return new Dictionary<string, object?>
{
["simpleOutput"] = simple.Apply(getApiIntegrationsResult => getApiIntegrationsResult.ApiIntegrations),
["likeOutput"] = like.Apply(getApiIntegrationsResult => getApiIntegrationsResult.ApiIntegrations),
["likePrefixOutput"] = likePrefix.Apply(getApiIntegrationsResult => getApiIntegrationsResult.ApiIntegrations),
["onlyShowOutput"] = onlyShow.Apply(getApiIntegrationsResult => getApiIntegrationsResult.ApiIntegrations),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.snowflake.SnowflakeFunctions;
import com.pulumi.snowflake.inputs.GetApiIntegrationsArgs;
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) {
// Simple usage
final var simple = SnowflakeFunctions.getApiIntegrations(GetApiIntegrationsArgs.builder()
.build());
ctx.export("simpleOutput", simple.apiIntegrations());
// Filtering (like)
final var like = SnowflakeFunctions.getApiIntegrations(GetApiIntegrationsArgs.builder()
.like("api-integration-name")
.build());
ctx.export("likeOutput", like.apiIntegrations());
// Filtering by prefix (like)
final var likePrefix = SnowflakeFunctions.getApiIntegrations(GetApiIntegrationsArgs.builder()
.like("prefix%")
.build());
ctx.export("likePrefixOutput", likePrefix.apiIntegrations());
// Without additional data (to limit the number of calls made for every found API integration)
final var onlyShow = SnowflakeFunctions.getApiIntegrations(GetApiIntegrationsArgs.builder()
.withDescribe(false)
.build());
ctx.export("onlyShowOutput", onlyShow.apiIntegrations());
}
}
variables:
# Simple usage
simple:
fn::invoke:
function: snowflake:getApiIntegrations
arguments: {}
# Filtering (like)
like:
fn::invoke:
function: snowflake:getApiIntegrations
arguments:
like: api-integration-name
# Filtering by prefix (like)
likePrefix:
fn::invoke:
function: snowflake:getApiIntegrations
arguments:
like: prefix%
# Without additional data (to limit the number of calls made for every found API integration)
onlyShow:
fn::invoke:
function: snowflake:getApiIntegrations
arguments:
withDescribe: false
outputs:
simpleOutput: ${simple.apiIntegrations}
likeOutput: ${like.apiIntegrations}
likePrefixOutput: ${likePrefix.apiIntegrations}
onlyShowOutput: ${onlyShow.apiIntegrations}
pulumi {
required_providers {
snowflake = {
source = "pulumi/snowflake"
}
}
}
data "snowflake_getapiintegrations" "simple" {
}
data "snowflake_getapiintegrations" "like" {
like = "api-integration-name"
}
data "snowflake_getapiintegrations" "likePrefix" {
like = "prefix%"
}
data "snowflake_getapiintegrations" "onlyShow" {
with_describe = false
}
# Simple usage
output "simpleOutput" {
value = data.snowflake_getapiintegrations.simple.api_integrations
}
# Filtering (like)
output "likeOutput" {
value = data.snowflake_getapiintegrations.like.api_integrations
}
# Filtering by prefix (like)
output "likePrefixOutput" {
value = data.snowflake_getapiintegrations.likePrefix.api_integrations
}
# Without additional data (to limit the number of calls made for every found API integration)
# with_describe is turned on by default and it calls DESCRIBE API INTEGRATION for every integration found and attaches its output to api_integrations.*.describe_output field
output "onlyShowOutput" {
value = data.snowflake_getapiintegrations.onlyShow.api_integrations
}
Note If a field has a default value, it is shown next to the type in the schema.
Using getApiIntegrations
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 getApiIntegrations(args: GetApiIntegrationsArgs, opts?: InvokeOptions): Promise<GetApiIntegrationsResult>
function getApiIntegrationsOutput(args: GetApiIntegrationsOutputArgs, opts?: InvokeOptions): Output<GetApiIntegrationsResult>def get_api_integrations(like: Optional[str] = None,
with_describe: Optional[bool] = None,
opts: Optional[InvokeOptions] = None) -> GetApiIntegrationsResult
def get_api_integrations_output(like: pulumi.Input[Optional[str]] = None,
with_describe: pulumi.Input[Optional[bool]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetApiIntegrationsResult]func GetApiIntegrations(ctx *Context, args *GetApiIntegrationsArgs, opts ...InvokeOption) (*GetApiIntegrationsResult, error)
func GetApiIntegrationsOutput(ctx *Context, args *GetApiIntegrationsOutputArgs, opts ...InvokeOption) GetApiIntegrationsResultOutput> Note: This function is named GetApiIntegrations in the Go SDK.
public static class GetApiIntegrations
{
public static Task<GetApiIntegrationsResult> InvokeAsync(GetApiIntegrationsArgs args, InvokeOptions? opts = null)
public static Output<GetApiIntegrationsResult> Invoke(GetApiIntegrationsInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetApiIntegrationsResult> getApiIntegrations(GetApiIntegrationsArgs args, InvokeOptions options)
public static Output<GetApiIntegrationsResult> getApiIntegrations(GetApiIntegrationsArgs args, InvokeOptions options)
fn::invoke:
function: snowflake:index/getApiIntegrations:getApiIntegrations
arguments:
# arguments dictionarydata "snowflake_get_api_integrations" "name" {
# arguments
}The following arguments are supported:
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - With
Describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - With
Describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with_
describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe Boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- like str
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with_
describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe Boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
getApiIntegrations Result
The following output properties are available:
- Api
Integrations List<GetApi Integrations Api Integration> - Holds the aggregated output of all API integration details queries.
- Id string
- The provider-assigned unique ID for this managed resource.
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - With
Describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- Api
Integrations []GetApi Integrations Api Integration - Holds the aggregated output of all API integration details queries.
- Id string
- The provider-assigned unique ID for this managed resource.
- Like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - With
Describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- api_
integrations list(object) - Holds the aggregated output of all API integration details queries.
- id string
- The provider-assigned unique ID for this managed resource.
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with_
describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- api
Integrations List<GetApi Integrations Api Integration> - Holds the aggregated output of all API integration details queries.
- id String
- The provider-assigned unique ID for this managed resource.
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe Boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- api
Integrations GetApi Integrations Api Integration[] - Holds the aggregated output of all API integration details queries.
- id string
- The provider-assigned unique ID for this managed resource.
- like string
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- api_
integrations Sequence[GetApi Integrations Api Integration] - Holds the aggregated output of all API integration details queries.
- id str
- The provider-assigned unique ID for this managed resource.
- like str
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with_
describe bool - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
- api
Integrations List<Property Map> - Holds the aggregated output of all API integration details queries.
- id String
- The provider-assigned unique ID for this managed resource.
- like String
- Filters the output with case-insensitive pattern, with support for SQL wildcard characters (
%and_). - with
Describe Boolean - (Default:
true) Runs DESC API INTEGRATION for each integration returned by SHOW API INTEGRATIONS. The output of describe is saved to the describeOutput field. By default this value is set to true.
Supporting Types
GetApiIntegrationsApiIntegration
- Describe
Outputs List<GetApi Integrations Api Integration Describe Output> - Holds the output of DESCRIBE API INTEGRATION.
- Show
Outputs List<GetApi Integrations Api Integration Show Output> - Holds the output of SHOW API INTEGRATIONS.
- Describe
Outputs []GetApi Integrations Api Integration Describe Output - Holds the output of DESCRIBE API INTEGRATION.
- Show
Outputs []GetApi Integrations Api Integration Show Output - Holds the output of SHOW API INTEGRATIONS.
- describe_
outputs list(object) - Holds the output of DESCRIBE API INTEGRATION.
- show_
outputs list(object) - Holds the output of SHOW API INTEGRATIONS.
- describe
Outputs List<GetApi Integrations Api Integration Describe Output> - Holds the output of DESCRIBE API INTEGRATION.
- show
Outputs List<GetApi Integrations Api Integration Show Output> - Holds the output of SHOW API INTEGRATIONS.
- describe
Outputs GetApi Integrations Api Integration Describe Output[] - Holds the output of DESCRIBE API INTEGRATION.
- show
Outputs GetApi Integrations Api Integration Show Output[] - Holds the output of SHOW API INTEGRATIONS.
- describe_
outputs Sequence[GetApi Integrations Api Integration Describe Output] - Holds the output of DESCRIBE API INTEGRATION.
- show_
outputs Sequence[GetApi Integrations Api Integration Show Output] - Holds the output of SHOW API INTEGRATIONS.
- describe
Outputs List<Property Map> - Holds the output of DESCRIBE API INTEGRATION.
- show
Outputs List<Property Map> - Holds the output of SHOW API INTEGRATIONS.
GetApiIntegrationsApiIntegrationDescribeOutput
- Allowed
Authentication stringSecrets - Allowed
Prefixes List<string> - Api
Aws stringExternal Id - Api
Aws stringIam User Arn - Api
Aws stringRole Arn - Api
Key string - Api
Provider string - Azure
Ad stringApplication Id - Azure
Consent stringUrl - Azure
Multi stringTenant App Name - Azure
Tenant stringId - Blocked
Prefixes List<string> - Comment string
- Enabled bool
- Google
Api stringService Account - Google
Audience string - Oauth
Access intToken Validity - Oauth
Allowed List<string>Scopes - Oauth
Assertion stringIssuer - string
- Oauth
Client stringAuth Method - Oauth
Client stringId - Oauth
Grant string - Oauth
Refresh intToken Validity - Oauth
Resource stringUrl - Oauth
Token stringEndpoint - Oauth
Username string - Tls
Trusted List<string>Certificates - Use
Privatelink boolEndpoint - User
Auth stringType
- Allowed
Authentication stringSecrets - Allowed
Prefixes []string - Api
Aws stringExternal Id - Api
Aws stringIam User Arn - Api
Aws stringRole Arn - Api
Key string - Api
Provider string - Azure
Ad stringApplication Id - Azure
Consent stringUrl - Azure
Multi stringTenant App Name - Azure
Tenant stringId - Blocked
Prefixes []string - Comment string
- Enabled bool
- Google
Api stringService Account - Google
Audience string - Oauth
Access intToken Validity - Oauth
Allowed []stringScopes - Oauth
Assertion stringIssuer - string
- Oauth
Client stringAuth Method - Oauth
Client stringId - Oauth
Grant string - Oauth
Refresh intToken Validity - Oauth
Resource stringUrl - Oauth
Token stringEndpoint - Oauth
Username string - Tls
Trusted []stringCertificates - Use
Privatelink boolEndpoint - User
Auth stringType
- allowed_
authentication_ stringsecrets - allowed_
prefixes list(string) - api_
aws_ stringexternal_ id - api_
aws_ stringiam_ user_ arn - api_
aws_ stringrole_ arn - api_
key string - api_
provider string - azure_
ad_ stringapplication_ id - azure_
consent_ stringurl - azure_
multi_ stringtenant_ app_ name - azure_
tenant_ stringid - blocked_
prefixes list(string) - comment string
- enabled bool
- google_
api_ stringservice_ account - google_
audience string - oauth_
access_ numbertoken_ validity - oauth_
allowed_ list(string)scopes - oauth_
assertion_ stringissuer - string
- oauth_
client_ stringauth_ method - oauth_
client_ stringid - oauth_
grant string - oauth_
refresh_ numbertoken_ validity - oauth_
resource_ stringurl - oauth_
token_ stringendpoint - oauth_
username string - tls_
trusted_ list(string)certificates - use_
privatelink_ boolendpoint - user_
auth_ stringtype
- allowed
Authentication StringSecrets - allowed
Prefixes List<String> - api
Aws StringExternal Id - api
Aws StringIam User Arn - api
Aws StringRole Arn - api
Key String - api
Provider String - azure
Ad StringApplication Id - azure
Consent StringUrl - azure
Multi StringTenant App Name - azure
Tenant StringId - blocked
Prefixes List<String> - comment String
- enabled Boolean
- google
Api StringService Account - google
Audience String - oauth
Access IntegerToken Validity - oauth
Allowed List<String>Scopes - oauth
Assertion StringIssuer - String
- oauth
Client StringAuth Method - oauth
Client StringId - oauth
Grant String - oauth
Refresh IntegerToken Validity - oauth
Resource StringUrl - oauth
Token StringEndpoint - oauth
Username String - tls
Trusted List<String>Certificates - use
Privatelink BooleanEndpoint - user
Auth StringType
- allowed
Authentication stringSecrets - allowed
Prefixes string[] - api
Aws stringExternal Id - api
Aws stringIam User Arn - api
Aws stringRole Arn - api
Key string - api
Provider string - azure
Ad stringApplication Id - azure
Consent stringUrl - azure
Multi stringTenant App Name - azure
Tenant stringId - blocked
Prefixes string[] - comment string
- enabled boolean
- google
Api stringService Account - google
Audience string - oauth
Access numberToken Validity - oauth
Allowed string[]Scopes - oauth
Assertion stringIssuer - string
- oauth
Client stringAuth Method - oauth
Client stringId - oauth
Grant string - oauth
Refresh numberToken Validity - oauth
Resource stringUrl - oauth
Token stringEndpoint - oauth
Username string - tls
Trusted string[]Certificates - use
Privatelink booleanEndpoint - user
Auth stringType
- allowed_
authentication_ strsecrets - allowed_
prefixes Sequence[str] - api_
aws_ strexternal_ id - api_
aws_ striam_ user_ arn - api_
aws_ strrole_ arn - api_
key str - api_
provider str - azure_
ad_ strapplication_ id - azure_
consent_ strurl - azure_
multi_ strtenant_ app_ name - azure_
tenant_ strid - blocked_
prefixes Sequence[str] - comment str
- enabled bool
- google_
api_ strservice_ account - google_
audience str - oauth_
access_ inttoken_ validity - oauth_
allowed_ Sequence[str]scopes - oauth_
assertion_ strissuer - str
- oauth_
client_ strauth_ method - oauth_
client_ strid - oauth_
grant str - oauth_
refresh_ inttoken_ validity - oauth_
resource_ strurl - oauth_
token_ strendpoint - oauth_
username str - tls_
trusted_ Sequence[str]certificates - use_
privatelink_ boolendpoint - user_
auth_ strtype
- allowed
Authentication StringSecrets - allowed
Prefixes List<String> - api
Aws StringExternal Id - api
Aws StringIam User Arn - api
Aws StringRole Arn - api
Key String - api
Provider String - azure
Ad StringApplication Id - azure
Consent StringUrl - azure
Multi StringTenant App Name - azure
Tenant StringId - blocked
Prefixes List<String> - comment String
- enabled Boolean
- google
Api StringService Account - google
Audience String - oauth
Access NumberToken Validity - oauth
Allowed List<String>Scopes - oauth
Assertion StringIssuer - String
- oauth
Client StringAuth Method - oauth
Client StringId - oauth
Grant String - oauth
Refresh NumberToken Validity - oauth
Resource StringUrl - oauth
Token StringEndpoint - oauth
Username String - tls
Trusted List<String>Certificates - use
Privatelink BooleanEndpoint - user
Auth StringType
GetApiIntegrationsApiIntegrationShowOutput
Package Details
- Repository
- Snowflake pulumi/pulumi-snowflake
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
snowflakeTerraform Provider.
published on Wednesday, Jul 8, 2026 by Pulumi