1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getAccessListApiKey
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

mongodbatlas.getAccessListApiKey

mongodbatlas logo
MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-mongodbatlas

    Example Usage

    Using CIDR Block

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  testAccessListApiKey:
    type: mongodbatlas:AccessListApiKey
    name: test
    properties:
      orgId: <ORG_ID>
      cidrBlock: 1.2.3.4/32
      apiKey: a29120e123cd
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getAccessListApiKey
      arguments:
        orgId: ${testAccessListApiKey.orgId}
        cidrBlock: ${testAccessListApiKey.cidrBlock}
        apiKeyId: ${testAccessListApiKey.apiKeyId}

    Using IP Address

    import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const testAccessListApiKey = new mongodbatlas.AccessListApiKey("test", {
    orgId: "<ORG_ID>",
    ipAddress: "2.3.4.5",
    apiKey: "a29120e123cd",
});
const test = mongodbatlas.getAccessListApiKeyOutput({
    orgId: testAccessListApiKey.orgId,
    ipAddress: testAccessListApiKey.ipAddress,
    apiKeyId: testAccessListApiKey.apiKeyId,
});

    import pulumi
import pulumi_mongodbatlas as mongodbatlas

test_access_list_api_key = mongodbatlas.AccessListApiKey("test",
    org_id="<ORG_ID>",
    ip_address="2.3.4.5",
    api_key="a29120e123cd")
test = mongodbatlas.get_access_list_api_key_output(org_id=test_access_list_api_key.org_id,
    ip_address=test_access_list_api_key.ip_address,
    api_key_id=test_access_list_api_key.api_key_id)

    package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v4/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		testAccessListApiKey, err := mongodbatlas.NewAccessListApiKey(ctx, "test", &mongodbatlas.AccessListApiKeyArgs{
			OrgId:     pulumi.String("<ORG_ID>"),
			IpAddress: pulumi.String("2.3.4.5"),
			ApiKey:    "a29120e123cd",
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupAccessListApiKeyOutput(ctx, mongodbatlas.GetAccessListApiKeyOutputArgs{
			OrgId:     testAccessListApiKey.OrgId,
			IpAddress: testAccessListApiKey.IpAddress,
			ApiKeyId:  testAccessListApiKey.ApiKeyId,
		}, nil)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var testAccessListApiKey = new Mongodbatlas.AccessListApiKey("test", new()
    {
        OrgId = "<ORG_ID>",
        IpAddress = "2.3.4.5",
        ApiKey = "a29120e123cd",
    });

    var test = Mongodbatlas.GetAccessListApiKey.Invoke(new()
    {
        OrgId = testAccessListApiKey.OrgId,
        IpAddress = testAccessListApiKey.IpAddress,
        ApiKeyId = testAccessListApiKey.ApiKeyId,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.AccessListApiKey;
import com.pulumi.mongodbatlas.AccessListApiKeyArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetAccessListApiKeyArgs;
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) {
        var testAccessListApiKey = new AccessListApiKey("testAccessListApiKey", AccessListApiKeyArgs.builder()
            .orgId("<ORG_ID>")
            .ipAddress("2.3.4.5")
            .apiKey("a29120e123cd")
            .build());

        final var test = MongodbatlasFunctions.getAccessListApiKey(GetAccessListApiKeyArgs.builder()
            .orgId(testAccessListApiKey.orgId())
            .ipAddress(testAccessListApiKey.ipAddress())
            .apiKeyId(testAccessListApiKey.apiKeyId())
            .build());

    }
}

    resources:
  testAccessListApiKey:
    type: mongodbatlas:AccessListApiKey
    name: test
    properties:
      orgId: <ORG_ID>
      ipAddress: 2.3.4.5
      apiKey: a29120e123cd
variables:
  test:
    fn::invoke:
      function: mongodbatlas:getAccessListApiKey
      arguments:
        orgId: ${testAccessListApiKey.orgId}
        ipAddress: ${testAccessListApiKey.ipAddress}
        apiKeyId: ${testAccessListApiKey.apiKeyId}

    Using getAccessListApiKey

    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 getAccessListApiKey(args: GetAccessListApiKeyArgs, opts?: InvokeOptions): Promise<GetAccessListApiKeyResult>
function getAccessListApiKeyOutput(args: GetAccessListApiKeyOutputArgs, opts?: InvokeOptions): Output<GetAccessListApiKeyResult>
    def get_access_list_api_key(api_key_id: Optional[str] = None,
                            ip_address: Optional[str] = None,
                            org_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAccessListApiKeyResult
def get_access_list_api_key_output(api_key_id: Optional[pulumi.Input[str]] = None,
                            ip_address: Optional[pulumi.Input[str]] = None,
                            org_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAccessListApiKeyResult]
    func LookupAccessListApiKey(ctx *Context, args *LookupAccessListApiKeyArgs, opts ...InvokeOption) (*LookupAccessListApiKeyResult, error)
func LookupAccessListApiKeyOutput(ctx *Context, args *LookupAccessListApiKeyOutputArgs, opts ...InvokeOption) LookupAccessListApiKeyResultOutput

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

    public static class GetAccessListApiKey 
{
    public static Task<GetAccessListApiKeyResult> InvokeAsync(GetAccessListApiKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetAccessListApiKeyResult> Invoke(GetAccessListApiKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAccessListApiKeyResult> getAccessListApiKey(GetAccessListApiKeyArgs args, InvokeOptions options)
public static Output<GetAccessListApiKeyResult> getAccessListApiKey(GetAccessListApiKeyArgs args, InvokeOptions options)

    fn::invoke:
  function: mongodbatlas:index/getAccessListApiKey:getAccessListApiKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApiKeyId string
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    IpAddress string
    Single IP address to be added to the access list.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    ApiKeyId string
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    IpAddress string
    Single IP address to be added to the access list.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId String
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress String
    Single IP address to be added to the access list.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId string
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress string
    Single IP address to be added to the access list.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    api_key_id str
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ip_address str
    Single IP address to be added to the access list.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    apiKeyId String
    Unique identifier for the Organization API Key for which you want to retrieve an access list entry. * ->NOTE: You must set either the cidr_block attribute or the ip_address attribute. Don't set both.
    ipAddress String
    Single IP address to be added to the access list.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

    getAccessListApiKey Result

    The following output properties are available:

    AccessCount int
    ApiKeyId string
    CidrBlock string
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    LastUsed string
    LastUsedAddress string
    OrgId string
    AccessCount int
    ApiKeyId string
    CidrBlock string
    Created string
    Id string
    The provider-assigned unique ID for this managed resource.
    IpAddress string
    LastUsed string
    LastUsedAddress string
    OrgId string
    accessCount Integer
    apiKeyId String
    cidrBlock String
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    lastUsed String
    lastUsedAddress String
    orgId String
    accessCount number
    apiKeyId string
    cidrBlock string
    created string
    id string
    The provider-assigned unique ID for this managed resource.
    ipAddress string
    lastUsed string
    lastUsedAddress string
    orgId string
    access_count int
    api_key_id str
    cidr_block str
    created str
    id str
    The provider-assigned unique ID for this managed resource.
    ip_address str
    last_used str
    last_used_address str
    org_id str
    accessCount Number
    apiKeyId String
    cidrBlock String
    created String
    id String
    The provider-assigned unique ID for this managed resource.
    ipAddress String
    lastUsed String
    lastUsedAddress String
    orgId String

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v4.0.0 published on Tuesday, Dec 30, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-mongodbatlas
      Meet Neo: Your AI Platform Teammate