Oracle Cloud Infrastructure v3.9.0, Sep 24 25

Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

oci.ApiGateway.getGateways

Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

Example Usage

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

const testGateways = oci.ApiGateway.getGateways({
    compartmentId: compartmentId,
    certificateId: ociApigatewayCertificate.testCertificate.id,
    displayName: gatewayDisplayName,
    state: gatewayState,
});

import pulumi
import pulumi_oci as oci

test_gateways = oci.ApiGateway.get_gateways(compartment_id=compartment_id,
    certificate_id=oci_apigateway_certificate["testCertificate"]["id"],
    display_name=gateway_display_name,
    state=gateway_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.GetGateways(ctx, &apigateway.GetGatewaysArgs{
			CompartmentId: compartmentId,
			CertificateId: pulumi.StringRef(ociApigatewayCertificate.TestCertificate.Id),
			DisplayName:   pulumi.StringRef(gatewayDisplayName),
			State:         pulumi.StringRef(gatewayState),
		}, 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 testGateways = Oci.ApiGateway.GetGateways.Invoke(new()
    {
        CompartmentId = compartmentId,
        CertificateId = ociApigatewayCertificate.TestCertificate.Id,
        DisplayName = gatewayDisplayName,
        State = gatewayState,
    });

});

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.GetGatewaysArgs;
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 testGateways = ApiGatewayFunctions.getGateways(GetGatewaysArgs.builder()
            .compartmentId(compartmentId)
            .certificateId(ociApigatewayCertificate.testCertificate().id())
            .displayName(gatewayDisplayName)
            .state(gatewayState)
            .build());

    }
}

variables:
  testGateways:
    fn::invoke:
      function: oci:ApiGateway:getGateways
      arguments:
        compartmentId: ${compartmentId}
        certificateId: ${ociApigatewayCertificate.testCertificate.id}
        displayName: ${gatewayDisplayName}
        state: ${gatewayState}

Using getGateways

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 getGateways(args: GetGatewaysArgs, opts?: InvokeOptions): Promise<GetGatewaysResult>
function getGatewaysOutput(args: GetGatewaysOutputArgs, opts?: InvokeOptions): Output<GetGatewaysResult>

def get_gateways(certificate_id: Optional[str] = None,
                 compartment_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[GetGatewaysFilter]] = None,
                 state: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetGatewaysResult
def get_gateways_output(certificate_id: Optional[pulumi.Input[str]] = None,
                 compartment_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetGatewaysFilterArgs]]]] = None,
                 state: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetGatewaysResult]

func GetGateways(ctx *Context, args *GetGatewaysArgs, opts ...InvokeOption) (*GetGatewaysResult, error)
func GetGatewaysOutput(ctx *Context, args *GetGatewaysOutputArgs, opts ...InvokeOption) GetGatewaysResultOutput

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

public static class GetGateways 
{
    public static Task<GetGatewaysResult> InvokeAsync(GetGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewaysResult> Invoke(GetGatewaysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)
public static Output<GetGatewaysResult> getGateways(GetGatewaysArgs args, InvokeOptions options)

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

The following arguments are supported:

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

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

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

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

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

compartmentId String: The ocid of the compartment in which to list resources.
certificateId String: Filter gateways by the certificate ocid.
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: SUCCEEDED

getGateways Result

The following output properties are available:

CompartmentId string: The OCID of the compartment in which the resource is created.
GatewayCollections List<GetGatewaysGatewayCollection>: The list of gateway_collection.
Id string: The provider-assigned unique ID for this managed resource.
CertificateId string: The OCID of the 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<GetGatewaysFilter>
State string: The current state of the gateway.

CompartmentId string: The OCID of the compartment in which the resource is created.
GatewayCollections []GetGatewaysGatewayCollection: The list of gateway_collection.
Id string: The provider-assigned unique ID for this managed resource.
CertificateId string: The OCID of the 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 []GetGatewaysFilter
State string: The current state of the gateway.

compartmentId String: The OCID of the compartment in which the resource is created.
gatewayCollections List<GetGatewaysGatewayCollection>: The list of gateway_collection.
id String: The provider-assigned unique ID for this managed resource.
certificateId String: The OCID of the 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<GetGatewaysFilter>
state String: The current state of the gateway.

compartmentId string: The OCID of the compartment in which the resource is created.
gatewayCollections GetGatewaysGatewayCollection[]: The list of gateway_collection.
id string: The provider-assigned unique ID for this managed resource.
certificateId string: The OCID of the 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 GetGatewaysFilter[]
state string: The current state of the gateway.

compartment_id str: The OCID of the compartment in which the resource is created.
gateway_collections Sequence[GetGatewaysGatewayCollection]: The list of gateway_collection.
id str: The provider-assigned unique ID for this managed resource.
certificate_id str: The OCID of the 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[GetGatewaysFilter]
state str: The current state of the gateway.

compartmentId String: The OCID of the compartment in which the resource is created.
gatewayCollections List<Property Map>: The list of gateway_collection.
id String: The provider-assigned unique ID for this managed resource.
certificateId String: The OCID of the 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 gateway.

Supporting Types

GetGatewaysFilter

Name string
Values List<string>
Regex bool

Name string
Values []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

GetGatewaysGatewayCollection

CaBundles List<GetGatewaysGatewayCollectionCaBundle>: An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string: Filter gateways by the certificate ocid.
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"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
EndpointType string: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
Hostname string: The hostname for APIs deployed on the gateway.
Id string: The OCID of the resource.
IpAddresses List<GetGatewaysGatewayCollectionIpAddress>: An array of IP addresses associated with the gateway.
IsLockOverride bool
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
Locks List<GetGatewaysGatewayCollectionLock>: Locks associated with this resource.
NetworkSecurityGroupIds List<string>: An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails List<GetGatewaysGatewayCollectionResponseCacheDetail>: Base Gateway response cache.
State string: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
SubnetId string: The OCID of the subnet in which related resources are created.
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.

CaBundles []GetGatewaysGatewayCollectionCaBundle: An array of CA bundles that should be used on the Gateway for TLS validation.
CertificateId string: Filter gateways by the certificate ocid.
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"}
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
EndpointType string: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
Hostname string: The hostname for APIs deployed on the gateway.
Id string: The OCID of the resource.
IpAddresses []GetGatewaysGatewayCollectionIpAddress: An array of IP addresses associated with the gateway.
IsLockOverride bool
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
Locks []GetGatewaysGatewayCollectionLock: Locks associated with this resource.
NetworkSecurityGroupIds []string: An array of Network Security Groups OCIDs associated with this API Gateway.
ResponseCacheDetails []GetGatewaysGatewayCollectionResponseCacheDetail: Base Gateway response cache.
State string: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
SubnetId string: The OCID of the subnet in which related resources are created.
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.

caBundles List<GetGatewaysGatewayCollectionCaBundle>: An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String: Filter gateways by the certificate ocid.
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"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
endpointType String: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname String: The hostname for APIs deployed on the gateway.
id String: The OCID of the resource.
ipAddresses List<GetGatewaysGatewayCollectionIpAddress>: An array of IP addresses associated with the gateway.
isLockOverride Boolean
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
locks List<GetGatewaysGatewayCollectionLock>: Locks associated with this resource.
networkSecurityGroupIds List<String>: An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails List<GetGatewaysGatewayCollectionResponseCacheDetail>: Base Gateway response cache.
state String: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
subnetId String: The OCID of the subnet in which related resources are created.
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.

caBundles GetGatewaysGatewayCollectionCaBundle[]: An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId string: Filter gateways by the certificate ocid.
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"}
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
endpointType string: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname string: The hostname for APIs deployed on the gateway.
id string: The OCID of the resource.
ipAddresses GetGatewaysGatewayCollectionIpAddress[]: An array of IP addresses associated with the gateway.
isLockOverride boolean
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
locks GetGatewaysGatewayCollectionLock[]: Locks associated with this resource.
networkSecurityGroupIds string[]: An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails GetGatewaysGatewayCollectionResponseCacheDetail[]: Base Gateway response cache.
state string: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
subnetId string: The OCID of the subnet in which related resources are created.
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.

ca_bundles Sequence[GetGatewaysGatewayCollectionCaBundle]: An array of CA bundles that should be used on the Gateway for TLS validation.
certificate_id str: Filter gateways by the certificate ocid.
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"}
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
endpoint_type str: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname str: The hostname for APIs deployed on the gateway.
id str: The OCID of the resource.
ip_addresses Sequence[GetGatewaysGatewayCollectionIpAddress]: An array of IP addresses associated with the gateway.
is_lock_override bool
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
locks Sequence[GetGatewaysGatewayCollectionLock]: Locks associated with this resource.
network_security_group_ids Sequence[str]: An array of Network Security Groups OCIDs associated with this API Gateway.
response_cache_details Sequence[GetGatewaysGatewayCollectionResponseCacheDetail]: Base Gateway response cache.
state str: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
subnet_id str: The OCID of the subnet in which related resources are created.
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.

caBundles List<Property Map>: An array of CA bundles that should be used on the Gateway for TLS validation.
certificateId String: Filter gateways by the certificate ocid.
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"}
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource
endpointType String: Gateway endpoint type. PUBLIC will have a public ip address assigned to it, while PRIVATE will only be accessible on a private IP address on the subnet. Example: PUBLIC or PRIVATE
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"}
hostname String: The hostname for APIs deployed on the gateway.
id String: The OCID of the resource.
ipAddresses List<Property Map>: An array of IP addresses associated with the gateway.
isLockOverride Boolean
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
locks List<Property Map>: Locks associated with this resource.
networkSecurityGroupIds List<String>: An array of Network Security Groups OCIDs associated with this API Gateway.
responseCacheDetails List<Property Map>: Base Gateway response cache.
state String: A filter to return only resources that match the given lifecycle state. Example: SUCCEEDED
subnetId String: The OCID of the subnet in which related resources are created.
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.

GetGatewaysGatewayCollectionCaBundle

CaBundleId string: The OCID of the resource.
CertificateAuthorityId string: The OCID of the resource.
Type string: Type of the Response Cache.

CaBundleId string: The OCID of the resource.
CertificateAuthorityId string: The OCID of the resource.
Type string: Type of the Response Cache.

caBundleId String: The OCID of the resource.
certificateAuthorityId String: The OCID of the resource.
type String: Type of the Response Cache.

caBundleId string: The OCID of the resource.
certificateAuthorityId string: The OCID of the resource.
type string: Type of the Response Cache.

ca_bundle_id str: The OCID of the resource.
certificate_authority_id str: The OCID of the resource.
type str: Type of the Response Cache.

caBundleId String: The OCID of the resource.
certificateAuthorityId String: The OCID of the resource.
type String: Type of the Response Cache.

GetGatewaysGatewayCollectionIpAddress

IpAddress string: An IP address.

IpAddress string: An IP address.

ipAddress String: An IP address.

ipAddress string: An IP address.

ip_address str: An IP address.

ipAddress String: An IP address.

GetGatewaysGatewayCollectionLock

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 Response Cache.

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 Response Cache.

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 Response Cache.

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 Response Cache.

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 Response Cache.

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 Response Cache.

GetGatewaysGatewayCollectionResponseCacheDetail

AuthenticationSecretId string: The OCID of the Oracle Vault Service secret resource.
AuthenticationSecretVersionNumber string: The version number of the authentication secret to use.
ConnectTimeoutInMs int: Defines the timeout for establishing a connection with the Response Cache.
IsSslEnabled bool: Defines if the connection should be over SSL.
IsSslVerifyDisabled bool: Defines whether or not to uphold SSL verification.
ReadTimeoutInMs int: Defines the timeout for reading data from the Response Cache.
SendTimeoutInMs int: Defines the timeout for transmitting data to the Response Cache.
Servers List<GetGatewaysGatewayCollectionResponseCacheDetailServer>: The set of cache store members to connect to. At present only a single server is supported.
Type string: Type of the Response Cache.

AuthenticationSecretId string: The OCID of the Oracle Vault Service secret resource.
AuthenticationSecretVersionNumber string: The version number of the authentication secret to use.
ConnectTimeoutInMs int: Defines the timeout for establishing a connection with the Response Cache.
IsSslEnabled bool: Defines if the connection should be over SSL.
IsSslVerifyDisabled bool: Defines whether or not to uphold SSL verification.
ReadTimeoutInMs int: Defines the timeout for reading data from the Response Cache.
SendTimeoutInMs int: Defines the timeout for transmitting data to the Response Cache.
Servers []GetGatewaysGatewayCollectionResponseCacheDetailServer: The set of cache store members to connect to. At present only a single server is supported.
Type string: Type of the Response Cache.

authenticationSecretId String: The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber String: The version number of the authentication secret to use.
connectTimeoutInMs Integer: Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled Boolean: Defines if the connection should be over SSL.
isSslVerifyDisabled Boolean: Defines whether or not to uphold SSL verification.
readTimeoutInMs Integer: Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs Integer: Defines the timeout for transmitting data to the Response Cache.
servers List<GetGatewaysGatewayCollectionResponseCacheDetailServer>: The set of cache store members to connect to. At present only a single server is supported.
type String: Type of the Response Cache.

authenticationSecretId string: The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber string: The version number of the authentication secret to use.
connectTimeoutInMs number: Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled boolean: Defines if the connection should be over SSL.
isSslVerifyDisabled boolean: Defines whether or not to uphold SSL verification.
readTimeoutInMs number: Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs number: Defines the timeout for transmitting data to the Response Cache.
servers GetGatewaysGatewayCollectionResponseCacheDetailServer[]: The set of cache store members to connect to. At present only a single server is supported.
type string: Type of the Response Cache.

authentication_secret_id str: The OCID of the Oracle Vault Service secret resource.
authentication_secret_version_number str: The version number of the authentication secret to use.
connect_timeout_in_ms int: Defines the timeout for establishing a connection with the Response Cache.
is_ssl_enabled bool: Defines if the connection should be over SSL.
is_ssl_verify_disabled bool: Defines whether or not to uphold SSL verification.
read_timeout_in_ms int: Defines the timeout for reading data from the Response Cache.
send_timeout_in_ms int: Defines the timeout for transmitting data to the Response Cache.
servers Sequence[GetGatewaysGatewayCollectionResponseCacheDetailServer]: The set of cache store members to connect to. At present only a single server is supported.
type str: Type of the Response Cache.

authenticationSecretId String: The OCID of the Oracle Vault Service secret resource.
authenticationSecretVersionNumber String: The version number of the authentication secret to use.
connectTimeoutInMs Number: Defines the timeout for establishing a connection with the Response Cache.
isSslEnabled Boolean: Defines if the connection should be over SSL.
isSslVerifyDisabled Boolean: Defines whether or not to uphold SSL verification.
readTimeoutInMs Number: Defines the timeout for reading data from the Response Cache.
sendTimeoutInMs Number: Defines the timeout for transmitting data to the Response Cache.
servers List<Property Map>: The set of cache store members to connect to. At present only a single server is supported.
type String: Type of the Response Cache.

GetGatewaysGatewayCollectionResponseCacheDetailServer

Host string: Hostname or IP address (IPv4 only) where the cache store is running.
Port int: The port the cache store is exposed on.

Host string: Hostname or IP address (IPv4 only) where the cache store is running.
Port int: The port the cache store is exposed on.

host String: Hostname or IP address (IPv4 only) where the cache store is running.
port Integer: The port the cache store is exposed on.

host string: Hostname or IP address (IPv4 only) where the cache store is running.
port number: The port the cache store is exposed on.

host str: Hostname or IP address (IPv4 only) where the cache store is running.
port int: The port the cache store is exposed on.

host String: Hostname or IP address (IPv4 only) where the cache store is running.
port Number: The port the cache store is exposed on.

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.9.0 published on Wednesday, Sep 24, 2025 by Pulumi

pulumi/pulumi-oci

oci.ApiGateway.getGateways

On this page

On this page

Example Usage

Using getGateways

getGateways Result

Supporting Types

GetGatewaysFilter

GetGatewaysGatewayCollection

GetGatewaysGatewayCollectionCaBundle

GetGatewaysGatewayCollectionIpAddress

GetGatewaysGatewayCollectionLock

GetGatewaysGatewayCollectionResponseCacheDetail

GetGatewaysGatewayCollectionResponseCacheDetailServer

Package Details

On this page

On this page