1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getApiPlatformApiPlatformInstances
Oracle Cloud Infrastructure v3.12.0 published on Friday, Nov 21, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.getApiPlatformApiPlatformInstances

oci logo
Oracle Cloud Infrastructure v3.12.0 published on Friday, Nov 21, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides the list of Api Platform Instances in Oracle Cloud Infrastructure Api Platform service.

    Gets a list of API Platform Instances

    Example Usage

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

const testApiPlatformInstances = oci.oci.getApiPlatformApiPlatformInstances({
    compartmentId: compartmentId,
    id: apiPlatformInstanceId,
    name: apiPlatformInstanceName,
    state: apiPlatformInstanceState,
});

    import pulumi
import pulumi_oci as oci

test_api_platform_instances = oci.oci.get_api_platform_api_platform_instances(compartment_id=compartment_id,
    id=api_platform_instance_id,
    name=api_platform_instance_name,
    state=api_platform_instance_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.GetApiPlatformApiPlatformInstances(ctx, &oci.GetApiPlatformApiPlatformInstancesArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			Id:            pulumi.StringRef(apiPlatformInstanceId),
			Name:          pulumi.StringRef(apiPlatformInstanceName),
			State:         pulumi.StringRef(apiPlatformInstanceState),
		}, 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 testApiPlatformInstances = Oci.Oci.GetApiPlatformApiPlatformInstances.Invoke(new()
    {
        CompartmentId = compartmentId,
        Id = apiPlatformInstanceId,
        Name = apiPlatformInstanceName,
        State = apiPlatformInstanceState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.oci.OciFunctions;
import com.pulumi.oci.oci.inputs.GetApiPlatformApiPlatformInstancesArgs;
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) {
        final var testApiPlatformInstances = OciFunctions.getApiPlatformApiPlatformInstances(GetApiPlatformApiPlatformInstancesArgs.builder()
            .compartmentId(compartmentId)
            .id(apiPlatformInstanceId)
            .name(apiPlatformInstanceName)
            .state(apiPlatformInstanceState)
            .build());

    }
}

    variables:
  testApiPlatformInstances:
    fn::invoke:
      function: oci:oci:getApiPlatformApiPlatformInstances
      arguments:
        compartmentId: ${compartmentId}
        id: ${apiPlatformInstanceId}
        name: ${apiPlatformInstanceName}
        state: ${apiPlatformInstanceState}

    Using getApiPlatformApiPlatformInstances

    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 getApiPlatformApiPlatformInstances(args: GetApiPlatformApiPlatformInstancesArgs, opts?: InvokeOptions): Promise<GetApiPlatformApiPlatformInstancesResult>
function getApiPlatformApiPlatformInstancesOutput(args: GetApiPlatformApiPlatformInstancesOutputArgs, opts?: InvokeOptions): Output<GetApiPlatformApiPlatformInstancesResult>
    def get_api_platform_api_platform_instances(compartment_id: Optional[str] = None,
                                            filters: Optional[Sequence[GetApiPlatformApiPlatformInstancesFilter]] = None,
                                            id: Optional[str] = None,
                                            name: Optional[str] = None,
                                            state: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetApiPlatformApiPlatformInstancesResult
def get_api_platform_api_platform_instances_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetApiPlatformApiPlatformInstancesFilterArgs]]]] = None,
                                            id: Optional[pulumi.Input[str]] = None,
                                            name: Optional[pulumi.Input[str]] = None,
                                            state: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetApiPlatformApiPlatformInstancesResult]
    func GetApiPlatformApiPlatformInstances(ctx *Context, args *GetApiPlatformApiPlatformInstancesArgs, opts ...InvokeOption) (*GetApiPlatformApiPlatformInstancesResult, error)
func GetApiPlatformApiPlatformInstancesOutput(ctx *Context, args *GetApiPlatformApiPlatformInstancesOutputArgs, opts ...InvokeOption) GetApiPlatformApiPlatformInstancesResultOutput

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

    public static class GetApiPlatformApiPlatformInstances 
{
    public static Task<GetApiPlatformApiPlatformInstancesResult> InvokeAsync(GetApiPlatformApiPlatformInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetApiPlatformApiPlatformInstancesResult> Invoke(GetApiPlatformApiPlatformInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiPlatformApiPlatformInstancesResult> getApiPlatformApiPlatformInstances(GetApiPlatformApiPlatformInstancesArgs args, InvokeOptions options)
public static Output<GetApiPlatformApiPlatformInstancesResult> getApiPlatformApiPlatformInstances(GetApiPlatformApiPlatformInstancesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:oci/getApiPlatformApiPlatformInstances:getApiPlatformApiPlatformInstances
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    Filters List<GetApiPlatformApiPlatformInstancesFilter>
    Id string
    The OCID of the instance
    Name string
    A filter to return only resources that match the given name exactly
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    Filters []GetApiPlatformApiPlatformInstancesFilter
    Id string
    The OCID of the instance
    Name string
    A filter to return only resources that match the given name exactly
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    filters List<GetApiPlatformApiPlatformInstancesFilter>
    id String
    The OCID of the instance
    name String
    A filter to return only resources that match the given name exactly
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId string
    The OCID of the compartment in which to list resources.
    filters GetApiPlatformApiPlatformInstancesFilter[]
    id string
    The OCID of the instance
    name string
    A filter to return only resources that match the given name exactly
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartment_id str
    The OCID of the compartment in which to list resources.
    filters Sequence[GetApiPlatformApiPlatformInstancesFilter]
    id str
    The OCID of the instance
    name str
    A filter to return only resources that match the given name exactly
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    compartmentId String
    The OCID of the compartment in which to list resources.
    filters List<Property Map>
    id String
    The OCID of the instance
    name String
    A filter to return only resources that match the given name exactly
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    getApiPlatformApiPlatformInstances Result

    The following output properties are available:

    ApiPlatformInstanceCollections List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection>
    The list of api_platform_instance_collection.
    CompartmentId string
    The OCID of the compartment
    Filters List<GetApiPlatformApiPlatformInstancesFilter>
    Id string
    The OCID of the instance
    Name string
    A regionally unique, non-changeable instance name provided by the user during instance creation
    State string
    The current state of the instance
    ApiPlatformInstanceCollections []GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection
    The list of api_platform_instance_collection.
    CompartmentId string
    The OCID of the compartment
    Filters []GetApiPlatformApiPlatformInstancesFilter
    Id string
    The OCID of the instance
    Name string
    A regionally unique, non-changeable instance name provided by the user during instance creation
    State string
    The current state of the instance
    apiPlatformInstanceCollections List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection>
    The list of api_platform_instance_collection.
    compartmentId String
    The OCID of the compartment
    filters List<GetApiPlatformApiPlatformInstancesFilter>
    id String
    The OCID of the instance
    name String
    A regionally unique, non-changeable instance name provided by the user during instance creation
    state String
    The current state of the instance
    apiPlatformInstanceCollections GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection[]
    The list of api_platform_instance_collection.
    compartmentId string
    The OCID of the compartment
    filters GetApiPlatformApiPlatformInstancesFilter[]
    id string
    The OCID of the instance
    name string
    A regionally unique, non-changeable instance name provided by the user during instance creation
    state string
    The current state of the instance
    api_platform_instance_collections Sequence[GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection]
    The list of api_platform_instance_collection.
    compartment_id str
    The OCID of the compartment
    filters Sequence[GetApiPlatformApiPlatformInstancesFilter]
    id str
    The OCID of the instance
    name str
    A regionally unique, non-changeable instance name provided by the user during instance creation
    state str
    The current state of the instance
    apiPlatformInstanceCollections List<Property Map>
    The list of api_platform_instance_collection.
    compartmentId String
    The OCID of the compartment
    filters List<Property Map>
    id String
    The OCID of the instance
    name String
    A regionally unique, non-changeable instance name provided by the user during instance creation
    state String
    The current state of the instance

    Supporting Types

    GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollection

    GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItem

    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. Example: {"foo-namespace.bar-key": "value"}
    Description string
    User-provided changeable and non-unique description of the instance
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the instance
    IdcsApps List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    Name string
    A filter to return only resources that match the given name exactly
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri>
    Service URIs pertaining to the instance
    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. Example: {"foo-namespace.bar-key": "value"}
    Description string
    User-provided changeable and non-unique description of the instance
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the instance
    IdcsApps []GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp
    IDCS app associated with the instance, that can be used to manage the roles of the users
    LifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    Name string
    A filter to return only resources that match the given name exactly
    State string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    TimeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    Uris []GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri
    Service URIs pertaining to the instance
    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. Example: {"foo-namespace.bar-key": "value"}
    description String
    User-provided changeable and non-unique description of the instance
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the instance
    idcsApps List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name String
    A filter to return only resources that match the given name exactly
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri>
    Service URIs pertaining to the instance
    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. Example: {"foo-namespace.bar-key": "value"}
    description string
    User-provided changeable and non-unique description of the instance
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the instance
    idcsApps GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp[]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails string
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name string
    A filter to return only resources that match the given name exactly
    state string
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated string
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri[]
    Service URIs pertaining to the instance
    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. Example: {"foo-namespace.bar-key": "value"}
    description str
    User-provided changeable and non-unique description of the instance
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the instance
    idcs_apps Sequence[GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp]
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycle_details str
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name str
    A filter to return only resources that match the given name exactly
    state str
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    time_updated str
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris Sequence[GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri]
    Service URIs pertaining to the instance
    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. Example: {"foo-namespace.bar-key": "value"}
    description String
    User-provided changeable and non-unique description of the instance
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the instance
    idcsApps List<Property Map>
    IDCS app associated with the instance, that can be used to manage the roles of the users
    lifecycleDetails String
    A message that describes the current state of the instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state
    name String
    A filter to return only resources that match the given name exactly
    state String
    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
    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 the instance was created, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    timeUpdated String
    The date and time the instance was updated, in the format defined by RFC 3339 Example: 2016-08-25T21:10:29.600Z
    uris List<Property Map>
    Service URIs pertaining to the instance

    GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemIdcsApp

    Url string
    IDCS URL of the app
    Url string
    IDCS URL of the app
    url String
    IDCS URL of the app
    url string
    IDCS URL of the app
    url str
    IDCS URL of the app
    url String
    IDCS URL of the app

    GetApiPlatformApiPlatformInstancesApiPlatformInstanceCollectionItemUri

    DevelopersPortalUri string
    Developer's Portal URI of the instance (/developers)
    ManagementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    DevelopersPortalUri string
    Developer's Portal URI of the instance (/developers)
    ManagementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri String
    Developer's Portal URI of the instance (/developers)
    managementPortalUri String
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri string
    Developer's Portal URI of the instance (/developers)
    managementPortalUri string
    Management Portal URI of the instance (/apiplatform)
    developers_portal_uri str
    Developer's Portal URI of the instance (/developers)
    management_portal_uri str
    Management Portal URI of the instance (/apiplatform)
    developersPortalUri String
    Developer's Portal URI of the instance (/developers)
    managementPortalUri String
    Management Portal URI of the instance (/apiplatform)

    GetApiPlatformApiPlatformInstancesFilter

    Name string
    A filter to return only resources that match the given name exactly
    Values List<string>
    Regex bool
    Name string
    A filter to return only resources that match the given name exactly
    Values []string
    Regex bool
    name String
    A filter to return only resources that match the given name exactly
    values List<String>
    regex Boolean
    name string
    A filter to return only resources that match the given name exactly
    values string[]
    regex boolean
    name str
    A filter to return only resources that match the given name exactly
    values Sequence[str]
    regex bool
    name String
    A filter to return only resources that match the given name exactly
    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
    Oracle Cloud Infrastructure v3.12.0 published on Friday, Nov 21, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate