Oracle Cloud Infrastructure v3.7.0, Sep 13 25

Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

oci.ApiGateway.getApis

Explore with Pulumi AI

Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

Example Usage

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

const testApis = oci.ApiGateway.getApis({
    compartmentId: compartmentId,
    displayName: apiDisplayName,
    state: apiState,
});

import pulumi
import pulumi_oci as oci

test_apis = oci.ApiGateway.get_apis(compartment_id=compartment_id,
    display_name=api_display_name,
    state=api_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetApis(ctx, &apigateway.GetApisArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(apiDisplayName),
			State:         pulumi.StringRef(apiState),
		}, 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 testApis = Oci.ApiGateway.GetApis.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = apiDisplayName,
        State = apiState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ApiGateway.ApiGatewayFunctions;
import com.pulumi.oci.ApiGateway.inputs.GetApisArgs;
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 testApis = ApiGatewayFunctions.getApis(GetApisArgs.builder()
            .compartmentId(compartmentId)
            .displayName(apiDisplayName)
            .state(apiState)
            .build());

    }
}

variables:
  testApis:
    fn::invoke:
      function: oci:ApiGateway:getApis
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${apiDisplayName}
        state: ${apiState}

Using getApis

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 getApis(args: GetApisArgs, opts?: InvokeOptions): Promise<GetApisResult>
function getApisOutput(args: GetApisOutputArgs, opts?: InvokeOptions): Output<GetApisResult>

def get_apis(compartment_id: Optional[str] = None,
             display_name: Optional[str] = None,
             filters: Optional[Sequence[GetApisFilter]] = None,
             state: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetApisResult
def get_apis_output(compartment_id: Optional[pulumi.Input[str]] = None,
             display_name: Optional[pulumi.Input[str]] = None,
             filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetApisFilterArgs]]]] = None,
             state: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetApisResult]

func GetApis(ctx *Context, args *GetApisArgs, opts ...InvokeOption) (*GetApisResult, error)
func GetApisOutput(ctx *Context, args *GetApisOutputArgs, opts ...InvokeOption) GetApisResultOutput

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

public static class GetApis 
{
    public static Task<GetApisResult> InvokeAsync(GetApisArgs args, InvokeOptions? opts = null)
    public static Output<GetApisResult> Invoke(GetApisInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApisResult> getApis(GetApisArgs args, InvokeOptions options)
public static Output<GetApisResult> getApis(GetApisArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ApiGateway/getApis:getApis
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ocid of the compartment in which to list resources.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Filters List<GetApisFilter>
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

CompartmentId string: The ocid of the compartment in which to list resources.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
Filters []GetApisFilter
State string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId String: The ocid of the compartment in which to list resources.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters List<GetApisFilter>
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId string: The ocid of the compartment in which to list resources.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters GetApisFilter[]
state string: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartment_id str: The ocid of the compartment in which to list resources.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters Sequence[GetApisFilter]
state str: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

compartmentId String: The ocid of the compartment in which to list resources.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
filters List<Property Map>
state String: A filter to return only resources that match the given lifecycle state. Example: ACTIVE

getApis Result

The following output properties are available:

ApiCollections List<GetApisApiCollection>: The list of api_collection.
CompartmentId string: The OCID of the compartment in which the resource is created.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters List<GetApisFilter>
State string: The current state of the API.

ApiCollections []GetApisApiCollection: The list of api_collection.
CompartmentId string: The OCID of the compartment in which the resource is created.
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters []GetApisFilter
State string: The current state of the API.

apiCollections List<GetApisApiCollection>: The list of api_collection.
compartmentId String: The OCID of the compartment in which the resource is created.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<GetApisFilter>
state String: The current state of the API.

apiCollections GetApisApiCollection[]: The list of api_collection.
compartmentId string: The OCID of the compartment in which the resource is created.
id string: The provider-assigned unique ID for this managed resource.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters GetApisFilter[]
state string: The current state of the API.

api_collections Sequence[GetApisApiCollection]: The list of api_collection.
compartment_id str: The OCID of the compartment in which the resource is created.
id str: The provider-assigned unique ID for this managed resource.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters Sequence[GetApisFilter]
state str: The current state of the API.

apiCollections List<Property Map>: The list of api_collection.
compartmentId String: The OCID of the compartment in which the resource is created.
id String: The provider-assigned unique ID for this managed resource.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<Property Map>
state String: The current state of the API.

Supporting Types

GetApisApiCollection

Items List<GetApisApiCollectionItem>

Items []GetApisApiCollectionItem

items List<GetApisApiCollectionItem>

items GetApisApiCollectionItem[]

items Sequence[GetApisApiCollectionItem]

items List<Property Map>

GetApisApiCollectionItem

CompartmentId string

The ocid of the compartment in which to list resources.

Content string

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"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

IsLockOverride bool

LifecycleDetails string

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

Locks List<GetApisApiCollectionItemLock>

Locks associated with this resource.

SpecificationType string

Type of API Specification file.

State string

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

ValidationResults List<GetApisApiCollectionItemValidationResult>

Status of each feature available from the API.

CompartmentId string

The ocid of the compartment in which to list resources.

Content string

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"}

DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

IsLockOverride bool

LifecycleDetails string

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

Locks []GetApisApiCollectionItemLock

Locks associated with this resource.

SpecificationType string

Type of API Specification file.

State string

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

ValidationResults []GetApisApiCollectionItemValidationResult

Status of each feature available from the API.

compartmentId String

The ocid of the compartment in which to list resources.

content String

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"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

isLockOverride Boolean

lifecycleDetails String

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

locks List<GetApisApiCollectionItemLock>

Locks associated with this resource.

specificationType String

Type of API Specification file.

state String

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

validationResults List<GetApisApiCollectionItemValidationResult>

Status of each feature available from the API.

compartmentId string

The ocid of the compartment in which to list resources.

content string

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"}

displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

isLockOverride boolean

lifecycleDetails string

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

locks GetApisApiCollectionItemLock[]

Locks associated with this resource.

specificationType string

Type of API Specification file.

state string

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

timeUpdated string

The time this resource was last updated. An RFC3339 formatted datetime string.

validationResults GetApisApiCollectionItemValidationResult[]

Status of each feature available from the API.

compartment_id str

The ocid of the compartment in which to list resources.

content str

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"}

display_name str

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

is_lock_override bool

lifecycle_details str

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

locks Sequence[GetApisApiCollectionItemLock]

Locks associated with this resource.

specification_type str

Type of API Specification file.

state str

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

time_updated str

The time this resource was last updated. An RFC3339 formatted datetime string.

validation_results Sequence[GetApisApiCollectionItemValidationResult]

Status of each feature available from the API.

compartmentId String

The ocid of the compartment in which to list resources.

content String

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"}

displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

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 resource.

isLockOverride Boolean

lifecycleDetails String

A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are:

'New' for just updated API Specifications
'Validating' for a document which is being validated.
'Valid' the document has been validated without any errors or warnings
'Warning' the document has been validated and contains warnings
'Error' the document has been validated and contains errors
'Failed' the document validation failed
'Canceled' the document validation was canceled

locks List<Property Map>

Locks associated with this resource.

specificationType String

Type of API Specification file.

state String

A filter to return only resources that match the given lifecycle state. Example: ACTIVE

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 time this resource was created. An RFC3339 formatted datetime string.

timeUpdated String

The time this resource was last updated. An RFC3339 formatted datetime string.

validationResults List<Property Map>

Status of each feature available from the API.

GetApisApiCollectionItemLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

GetApisApiCollectionItemValidationResult

Name string: Name of the validation.
Result string: Result of the validation.

Name string: Name of the validation.
Result string: Result of the validation.

name String: Name of the validation.
result String: Result of the validation.

name string: Name of the validation.
result string: Result of the validation.

name str: Name of the validation.
result str: Result of the validation.

name String: Name of the validation.
result String: Result of the validation.

GetApisFilter

Name string: Name of the validation.
Values List<string>
Regex bool

Name string: Name of the validation.
Values []string
Regex bool

name String: Name of the validation.
values List<String>
regex Boolean

name string: Name of the validation.
values string[]
regex boolean

name str: Name of the validation.
values Sequence[str]
regex bool

name String: Name of the validation.
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.

Oracle Cloud Infrastructure v3.7.0 published on Saturday, Sep 13, 2025 by Pulumi

pulumi/pulumi-oci

oci.ApiGateway.getApis

On this page

On this page

Example Usage

Using getApis

getApis Result

Supporting Types

GetApisApiCollection

GetApisApiCollectionItem

GetApisApiCollectionItemLock

GetApisApiCollectionItemValidationResult

GetApisFilter

Package Details

On this page

On this page