1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. oci
  5. getApiPlatformApiPlatformInstance
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.oci.getApiPlatformApiPlatformInstance

logo
Viewing docs for Oracle Cloud Infrastructure v4.5.0
published on Thursday, Apr 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides details about a specific Api Platform Instance resource in Oracle Cloud Infrastructure Api Platform service.

    Gets information about an API Platform Instance

    Example Usage

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

const testApiPlatformInstance = oci.oci.getApiPlatformApiPlatformInstance({
    apiPlatformInstanceId: testApiPlatformInstanceOciApiPlatformApiPlatformInstance.id,
});

    import pulumi
import pulumi_oci as oci

test_api_platform_instance = oci.oci.get_api_platform_api_platform_instance(api_platform_instance_id=test_api_platform_instance_oci_api_platform_api_platform_instance["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := oci.LookupApiPlatformApiPlatformInstance(ctx, &oci.LookupApiPlatformApiPlatformInstanceArgs{
			ApiPlatformInstanceId: testApiPlatformInstanceOciApiPlatformApiPlatformInstance.Id,
		}, 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 testApiPlatformInstance = Oci.Oci.GetApiPlatformApiPlatformInstance.Invoke(new()
    {
        ApiPlatformInstanceId = testApiPlatformInstanceOciApiPlatformApiPlatformInstance.Id,
    });

});

    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.GetApiPlatformApiPlatformInstanceArgs;
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 testApiPlatformInstance = OciFunctions.getApiPlatformApiPlatformInstance(GetApiPlatformApiPlatformInstanceArgs.builder()
            .apiPlatformInstanceId(testApiPlatformInstanceOciApiPlatformApiPlatformInstance.id())
            .build());

    }
}

    variables:
  testApiPlatformInstance:
    fn::invoke:
      function: oci:oci:getApiPlatformApiPlatformInstance
      arguments:
        apiPlatformInstanceId: ${testApiPlatformInstanceOciApiPlatformApiPlatformInstance.id}

    Using getApiPlatformApiPlatformInstance

    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 getApiPlatformApiPlatformInstance(args: GetApiPlatformApiPlatformInstanceArgs, opts?: InvokeOptions): Promise<GetApiPlatformApiPlatformInstanceResult>
function getApiPlatformApiPlatformInstanceOutput(args: GetApiPlatformApiPlatformInstanceOutputArgs, opts?: InvokeOptions): Output<GetApiPlatformApiPlatformInstanceResult>
    def get_api_platform_api_platform_instance(api_platform_instance_id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetApiPlatformApiPlatformInstanceResult
def get_api_platform_api_platform_instance_output(api_platform_instance_id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetApiPlatformApiPlatformInstanceResult]
    func LookupApiPlatformApiPlatformInstance(ctx *Context, args *LookupApiPlatformApiPlatformInstanceArgs, opts ...InvokeOption) (*LookupApiPlatformApiPlatformInstanceResult, error)
func LookupApiPlatformApiPlatformInstanceOutput(ctx *Context, args *LookupApiPlatformApiPlatformInstanceOutputArgs, opts ...InvokeOption) LookupApiPlatformApiPlatformInstanceResultOutput

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

    public static class GetApiPlatformApiPlatformInstance 
{
    public static Task<GetApiPlatformApiPlatformInstanceResult> InvokeAsync(GetApiPlatformApiPlatformInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetApiPlatformApiPlatformInstanceResult> Invoke(GetApiPlatformApiPlatformInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetApiPlatformApiPlatformInstanceResult> getApiPlatformApiPlatformInstance(GetApiPlatformApiPlatformInstanceArgs args, InvokeOptions options)
public static Output<GetApiPlatformApiPlatformInstanceResult> getApiPlatformApiPlatformInstance(GetApiPlatformApiPlatformInstanceArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ApiPlatformInstanceId string
    The OCID of the instance
    ApiPlatformInstanceId string
    The OCID of the instance
    apiPlatformInstanceId String
    The OCID of the instance
    apiPlatformInstanceId string
    The OCID of the instance
    api_platform_instance_id str
    The OCID of the instance
    apiPlatformInstanceId String
    The OCID of the instance

    getApiPlatformApiPlatformInstance Result

    The following output properties are available:

    ApiPlatformInstanceId string
    CompartmentId string
    The OCID of the compartment
    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<GetApiPlatformApiPlatformInstanceIdcsApp>
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    State string
    The current state of the instance
    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<GetApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    ApiPlatformInstanceId string
    CompartmentId string
    The OCID of the compartment
    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 []GetApiPlatformApiPlatformInstanceIdcsApp
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    State string
    The current state of the instance
    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 []GetApiPlatformApiPlatformInstanceUri
    Service URIs pertaining to the instance
    apiPlatformInstanceId String
    compartmentId String
    The OCID of the compartment
    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<GetApiPlatformApiPlatformInstanceIdcsApp>
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    state String
    The current state of the instance
    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<GetApiPlatformApiPlatformInstanceUri>
    Service URIs pertaining to the instance
    apiPlatformInstanceId string
    compartmentId string
    The OCID of the compartment
    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 GetApiPlatformApiPlatformInstanceIdcsApp[]
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    state string
    The current state of the instance
    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 GetApiPlatformApiPlatformInstanceUri[]
    Service URIs pertaining to the instance
    api_platform_instance_id str
    compartment_id str
    The OCID of the compartment
    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[GetApiPlatformApiPlatformInstanceIdcsApp]
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    state str
    The current state of the instance
    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[GetApiPlatformApiPlatformInstanceUri]
    Service URIs pertaining to the instance
    apiPlatformInstanceId String
    compartmentId String
    The OCID of the compartment
    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 regionally unique, non-changeable instance name provided by the user during instance creation
    state String
    The current state of the instance
    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

    Supporting Types

    GetApiPlatformApiPlatformInstanceIdcsApp

    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

    GetApiPlatformApiPlatformInstanceUri

    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)

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    logo
    Viewing docs for Oracle Cloud Infrastructure v4.5.0
    published on Thursday, Apr 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Try Pulumi Cloud free. Your team will thank you.