Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApiGateway
  5. getGateway
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.ApiGateway.getGateway

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Gateway resource in Oracle Cloud Infrastructure API Gateway service.

    Gets a gateway by identifier.

    Example Usage

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

const testGateway = oci.ApiGateway.getGateway({
    gatewayId: testGatewayOciApigatewayGateway.id,
});

    import pulumi
import pulumi_oci as oci

test_gateway = oci.ApiGateway.get_gateway(gateway_id=test_gateway_oci_apigateway_gateway["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigateway.GetGateway(ctx, &apigateway.GetGatewayArgs{
			GatewayId: testGatewayOciApigatewayGateway.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 testGateway = Oci.ApiGateway.GetGateway.Invoke(new()
    {
        GatewayId = testGatewayOciApigatewayGateway.Id,
    });

});

    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.GetGatewayArgs;
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 testGateway = ApiGatewayFunctions.getGateway(GetGatewayArgs.builder()
            .gatewayId(testGatewayOciApigatewayGateway.id())
            .build());

    }
}

    variables:
  testGateway:
    fn::invoke:
      function: oci:ApiGateway:getGateway
      arguments:
        gatewayId: ${testGatewayOciApigatewayGateway.id}

    Using getGateway

    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 getGateway(args: GetGatewayArgs, opts?: InvokeOptions): Promise<GetGatewayResult>
function getGatewayOutput(args: GetGatewayOutputArgs, opts?: InvokeOptions): Output<GetGatewayResult>
    def get_gateway(gateway_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGatewayResult
def get_gateway_output(gateway_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGatewayResult]
    func GetGateway(ctx *Context, args *GetGatewayArgs, opts ...InvokeOption) (*GetGatewayResult, error)
func GetGatewayOutput(ctx *Context, args *GetGatewayOutputArgs, opts ...InvokeOption) GetGatewayResultOutput

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

    public static class GetGateway 
{
    public static Task<GetGatewayResult> InvokeAsync(GetGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayResult> Invoke(GetGatewayInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)
public static Output<GetGatewayResult> getGateway(GetGatewayArgs args, InvokeOptions options)

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

    The following arguments are supported:

    GatewayId string
    The ocid of the gateway.
    GatewayId string
    The ocid of the gateway.
    gatewayId String
    The ocid of the gateway.
    gatewayId string
    The ocid of the gateway.
    gateway_id str
    The ocid of the gateway.
    gatewayId String
    The ocid of the gateway.

    getGateway Result

    The following output properties are available:

    CaBundles List<GetGatewayCaBundle>
    An array of CA bundles that should be used on the Gateway for TLS validation.
    CertificateId string
    The OCID of the resource.
    CompartmentId string
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    GatewayId string
    Hostname string
    The hostname for APIs deployed on the gateway.
    Id string
    The OCID of the resource.
    IpAddresses List<GetGatewayIpAddress>
    An array of IP addresses associated with the gateway.
    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.
    NetworkSecurityGroupIds List<string>
    An array of Network Security Groups OCIDs associated with this API Gateway.
    ResponseCacheDetails List<GetGatewayResponseCacheDetail>
    Base Gateway response cache.
    State string
    The current state of the gateway.
    SubnetId string
    The OCID of the subnet in which related resources are created.
    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 []GetGatewayCaBundle
    An array of CA bundles that should be used on the Gateway for TLS validation.
    CertificateId string
    The OCID of the resource.
    CompartmentId string
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    GatewayId string
    Hostname string
    The hostname for APIs deployed on the gateway.
    Id string
    The OCID of the resource.
    IpAddresses []GetGatewayIpAddress
    An array of IP addresses associated with the gateway.
    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.
    NetworkSecurityGroupIds []string
    An array of Network Security Groups OCIDs associated with this API Gateway.
    ResponseCacheDetails []GetGatewayResponseCacheDetail
    Base Gateway response cache.
    State string
    The current state of the gateway.
    SubnetId string
    The OCID of the subnet in which related resources are created.
    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<GetGatewayCaBundle>
    An array of CA bundles that should be used on the Gateway for TLS validation.
    certificateId String
    The OCID of the resource.
    compartmentId String
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    gatewayId String
    hostname String
    The hostname for APIs deployed on the gateway.
    id String
    The OCID of the resource.
    ipAddresses List<GetGatewayIpAddress>
    An array of IP addresses associated with the gateway.
    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.
    networkSecurityGroupIds List<String>
    An array of Network Security Groups OCIDs associated with this API Gateway.
    responseCacheDetails List<GetGatewayResponseCacheDetail>
    Base Gateway response cache.
    state String
    The current state of the gateway.
    subnetId String
    The OCID of the subnet in which related resources are created.
    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 GetGatewayCaBundle[]
    An array of CA bundles that should be used on the Gateway for TLS validation.
    certificateId string
    The OCID of the resource.
    compartmentId string
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    gatewayId string
    hostname string
    The hostname for APIs deployed on the gateway.
    id string
    The OCID of the resource.
    ipAddresses GetGatewayIpAddress[]
    An array of IP addresses associated with the gateway.
    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.
    networkSecurityGroupIds string[]
    An array of Network Security Groups OCIDs associated with this API Gateway.
    responseCacheDetails GetGatewayResponseCacheDetail[]
    Base Gateway response cache.
    state string
    The current state of the gateway.
    subnetId string
    The OCID of the subnet in which related resources are created.
    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[apigateway.GetGatewayCaBundle]
    An array of CA bundles that should be used on the Gateway for TLS validation.
    certificate_id str
    The OCID of the resource.
    compartment_id str
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    gateway_id str
    hostname str
    The hostname for APIs deployed on the gateway.
    id str
    The OCID of the resource.
    ip_addresses Sequence[apigateway.GetGatewayIpAddress]
    An array of IP addresses associated with the gateway.
    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.
    network_security_group_ids Sequence[str]
    An array of Network Security Groups OCIDs associated with this API Gateway.
    response_cache_details Sequence[apigateway.GetGatewayResponseCacheDetail]
    Base Gateway response cache.
    state str
    The current state of the gateway.
    subnet_id str
    The OCID of the subnet in which related resources are created.
    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
    The OCID of the resource.
    compartmentId String
    The OCID of the compartment in which the resource is created.
    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. Avoid entering confidential information. 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"}
    gatewayId String
    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.
    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.
    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
    The current state of the gateway.
    subnetId String
    The OCID of the subnet in which related resources are created.
    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.

    Supporting Types

    GetGatewayCaBundle

    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.

    GetGatewayIpAddress

    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.

    GetGatewayResponseCacheDetail

    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<GetGatewayResponseCacheDetailServer>
    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 []GetGatewayResponseCacheDetailServer
    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<GetGatewayResponseCacheDetailServer>
    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 GetGatewayResponseCacheDetailServer[]
    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[apigateway.GetGatewayResponseCacheDetailServer]
    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.

    GetGatewayResponseCacheDetailServer

    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.
    oci logo
    Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci