Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Oracle Cloud Infrastructure
  4. API Docs
  5. GenerativeAi
  6. getApikeys
Viewing docs for Oracle Cloud Infrastructure v5.6.0
published on Thursday, Nov 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.GenerativeAi.getApikeys

oci logo oci logo
Viewing docs for Oracle Cloud Infrastructure v5.6.0
published on Thursday, Nov 5, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides the list of Apikeys in Oracle Cloud Infrastructure Generative Ai service.

    Lists the ApiKeys of a specific compartment.

    Example Usage

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

const testApikeys = oci.generativeai.getApikeys({
    compartmentId: compartmentId,
    displayName: apikeyDisplayName,
    id: apikeyId,
    state: apikeyState,
});

    import pulumi
import pulumi_oci as oci

test_apikeys = oci.generativeai.get_apikeys(compartment_id=compartment_id,
    display_name=apikey_display_name,
    id=apikey_id,
    state=apikey_state)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v5/go/oci/generativeai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := generativeai.GetApikeys(ctx, &generativeai.GetApikeysArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(apikeyDisplayName),
			Id:            pulumi.StringRef(apikeyId),
			State:         pulumi.StringRef(apikeyState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testApikeys = Oci.GenerativeAi.GetApikeys.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = apikeyDisplayName,
        Id = apikeyId,
        State = apikeyState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
import com.pulumi.oci.GenerativeAi.inputs.GetApikeysArgs;
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 testApikeys = GenerativeAiFunctions.getApikeys(GetApikeysArgs.builder()
            .compartmentId(compartmentId)
            .displayName(apikeyDisplayName)
            .id(apikeyId)
            .state(apikeyState)
            .build());

    }
}

    variables:
  testApikeys:
    fn::invoke:
      function: oci:GenerativeAi:getApikeys
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${apikeyDisplayName}
        id: ${apikeyId}
        state: ${apikeyState}

    terraform {
  required_providers {
    oci = {
      source = "pulumi/oci"
    }
  }
}

data "oci_generative_ai_apikeys" "testApikeys" {
  compartment_id = compartmentId
  display_name   = apikeyDisplayName
  id             = apikeyId
  state          = apikeyState
}

    Using getApikeys

    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 getApikeys(args: GetApikeysArgs, opts?: InvokeOptions): Promise<GetApikeysResult>
function getApikeysOutput(args: GetApikeysOutputArgs, opts?: InvokeOutputOptions): Output<GetApikeysResult>
    def get_apikeys(compartment_id: Optional[str] = None,
                display_name: Optional[str] = None,
                filters: Optional[Sequence[GetApikeysFilter]] = None,
                id: Optional[str] = None,
                state: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetApikeysResult
def get_apikeys_output(compartment_id: pulumi.Input[Optional[str]] = None,
                display_name: pulumi.Input[Optional[str]] = None,
                filters: pulumi.Input[Optional[Sequence[pulumi.Input[GetApikeysFilterArgs]]]] = None,
                id: pulumi.Input[Optional[str]] = None,
                state: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = None) -> Output[GetApikeysResult]
    func GetApikeys(ctx *Context, args *GetApikeysArgs, opts ...InvokeOption) (*GetApikeysResult, error)
func GetApikeysOutput(ctx *Context, args *GetApikeysOutputArgs, opts ...InvokeOption) GetApikeysResultOutput

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

    public static class GetApikeys 
{
    public static Task<GetApikeysResult> InvokeAsync(GetApikeysArgs args, InvokeOptions? opts = null)
    public static Output<GetApikeysResult> Invoke(GetApikeysInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetApikeysResult> Invoke(GetApikeysInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetApikeysResult> getApikeys(GetApikeysArgs args, InvokeOptions options)
public static Output<GetApikeysResult> getApikeys(GetApikeysArgs args, InvokeOptions options)
public static Output<GetApikeysResult> getApikeys(GetApikeysArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: oci:GenerativeAi/getApikeys:getApikeys
  arguments:
    # arguments dictionary
    data "oci_generative_ai_get_apikeys" "name" {
    # arguments
}

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetApikeysFilter>
    Id string
    The OCID of the APIKey.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetApikeysFilter
    Id string
    The OCID of the APIKey.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    compartment_id string
    The OCID of the compartment in which to list resources.
    display_name string
    A filter to return only resources that match the given display name exactly.
    filters list(object)
    id string
    The OCID of the APIKey.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetApikeysFilter>
    id String
    The OCID of the APIKey.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetApikeysFilter[]
    id string
    The OCID of the APIKey.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetApikeysFilter]
    id str
    The OCID of the APIKey.
    state str
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    id String
    The OCID of the APIKey.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.

    getApikeys Result

    The following output properties are available:

    ApiKeyCollections List<GetApikeysApiKeyCollection>
    The list of api_key_collection.
    CompartmentId string
    The compartment OCID to create the apiKey in.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters List<GetApikeysFilter>
    Id string
    the ApiKey id.
    State string
    The current state of the API key.
    ApiKeyCollections []GetApikeysApiKeyCollection
    The list of api_key_collection.
    CompartmentId string
    The compartment OCID to create the apiKey in.
    DisplayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    Filters []GetApikeysFilter
    Id string
    the ApiKey id.
    State string
    The current state of the API key.
    api_key_collections list(object)
    The list of api_key_collection.
    compartment_id string
    The compartment OCID to create the apiKey in.
    display_name string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters list(object)
    id string
    the ApiKey id.
    state string
    The current state of the API key.
    apiKeyCollections List<GetApikeysApiKeyCollection>
    The list of api_key_collection.
    compartmentId String
    The compartment OCID to create the apiKey in.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<GetApikeysFilter>
    id String
    the ApiKey id.
    state String
    The current state of the API key.
    apiKeyCollections GetApikeysApiKeyCollection[]
    The list of api_key_collection.
    compartmentId string
    The compartment OCID to create the apiKey in.
    displayName string
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters GetApikeysFilter[]
    id string
    the ApiKey id.
    state string
    The current state of the API key.
    api_key_collections Sequence[GetApikeysApiKeyCollection]
    The list of api_key_collection.
    compartment_id str
    The compartment OCID to create the apiKey in.
    display_name str
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters Sequence[GetApikeysFilter]
    id str
    the ApiKey id.
    state str
    The current state of the API key.
    apiKeyCollections List<Property Map>
    The list of api_key_collection.
    compartmentId String
    The compartment OCID to create the apiKey in.
    displayName String
    A user-friendly name. Does not have to be unique, and it's changeable.
    filters List<Property Map>
    id String
    the ApiKey id.
    state String
    The current state of the API key.

    Supporting Types

    GetApikeysApiKeyCollection

    GetApikeysApiKeyCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    An optional description of the Api key.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the APIKey.
    Keys List<GetApikeysApiKeyCollectionItemKey>
    The list of keys.
    LifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    An optional description of the Api key.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the APIKey.
    Keys []GetApikeysApiKeyCollectionItemKey
    The list of keys.
    LifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    TimeUpdated string
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    compartment_id string
    The OCID of the compartment in which to list resources.
    defined_tags map(string)
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    An optional description of the Api key.
    display_name string
    A filter to return only resources that match the given display name exactly.
    freeform_tags map(string)
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the APIKey.
    keys list(object)
    The list of keys.
    lifecycle_details string
    A message describing the current state with detail that can provide actionable information.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    system_tags map(string)
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    time_updated string
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    An optional description of the Api key.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the APIKey.
    keys List<GetApikeysApiKeyCollectionItemKey>
    The list of keys.
    lifecycleDetails String
    A message describing the current state with detail that can provide actionable information.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    compartmentId string
    The OCID of the compartment in which to list resources.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    An optional description of the Api key.
    displayName string
    A filter to return only resources that match the given display name exactly.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the APIKey.
    keys GetApikeysApiKeyCollectionItemKey[]
    The list of keys.
    lifecycleDetails string
    A message describing the current state with detail that can provide actionable information.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeUpdated string
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    compartment_id str
    The OCID of the compartment in which to list resources.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    An optional description of the Api key.
    display_name str
    A filter to return only resources that match the given display name exactly.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the APIKey.
    keys Sequence[GetApikeysApiKeyCollectionItemKey]
    The list of keys.
    lifecycle_details str
    A message describing the current state with detail that can provide actionable information.
    state str
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    time_updated str
    The date and time the ApiKey was updated, in the format defined by RFC 3339.
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    An optional description of the Api key.
    displayName String
    A filter to return only resources that match the given display name exactly.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the APIKey.
    keys List<Property Map>
    The list of keys.
    lifecycleDetails String
    A message describing the current state with detail that can provide actionable information.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeUpdated String
    The date and time the ApiKey was updated, in the format defined by RFC 3339.

    GetApikeysApiKeyCollectionItemKey

    Key string
    The key.
    KeyMask string
    The masked key.
    KeyName string
    The key name.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    TimeActivated string
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    TimeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    TimeDeactivated string
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    TimeExpiry string
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    TimeLastUsed string
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    TimeRevoked string
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    Key string
    The key.
    KeyMask string
    The masked key.
    KeyName string
    The key name.
    State string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    TimeActivated string
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    TimeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    TimeDeactivated string
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    TimeExpiry string
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    TimeLastUsed string
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    TimeRevoked string
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    key string
    The key.
    key_mask string
    The masked key.
    key_name string
    The key name.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    time_activated string
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    time_created string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    time_deactivated string
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    time_expiry string
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    time_last_used string
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    time_revoked string
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    key String
    The key.
    keyMask String
    The masked key.
    keyName String
    The key name.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    timeActivated String
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    timeCreated String
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeDeactivated String
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    timeExpiry String
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    timeLastUsed String
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    timeRevoked String
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    key string
    The key.
    keyMask string
    The masked key.
    keyName string
    The key name.
    state string
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    timeActivated string
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    timeCreated string
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeDeactivated string
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    timeExpiry string
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    timeLastUsed string
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    timeRevoked string
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    key str
    The key.
    key_mask str
    The masked key.
    key_name str
    The key name.
    state str
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    time_activated str
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    time_created str
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    time_deactivated str
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    time_expiry str
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    time_last_used str
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    time_revoked str
    The date and time that the key is revoked in the format of an RFC3339 datetime string.
    key String
    The key.
    keyMask String
    The masked key.
    keyName String
    The key name.
    state String
    A filter to return only resources that their lifecycle state matches the given lifecycle state.
    timeActivated String
    The date and time that the key is activated in the format of an RFC3339 datetime string.
    timeCreated String
    The date and time that the ApiKey was created in the format of an RFC3339 datetime string.
    timeDeactivated String
    The date and time that the key is deactivated in the format of an RFC3339 datetime string.
    timeExpiry String
    The date and time when the key would be expired, if not provided it would be 90 days, in the format defined by RFC 3339.
    timeLastUsed String
    The date and time that the key is last used in the format of an RFC3339 datetime string.
    timeRevoked String
    The date and time that the key is revoked in the format of an RFC3339 datetime string.

    GetApikeysFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name string
    values list(string)
    regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo oci logo
    Viewing docs for Oracle Cloud Infrastructure v5.6.0
    published on Thursday, Nov 5, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial