Oracle Cloud Infrastructure Documentation

All Pages

Search... All Topics Search

Overview of API Gateway

The API Gateway service enables you to publish APIs with private endpoints that are accessible from within
your network, and which you can expose with public IP addresses if you want them to accept internet traffic.
The endpoints support API validation, request and response transformation, CORS, authentication and
authorization, and request limiting.

Using the API Gateway service, you create one or more API gateways in a regional subnet to process traffic
from front-end clients and route it to back-end services. You can use a single API gateway to link multiple
back-end services (such as load balancers, compute instances, and Oracle Functions) into a single
consolidated API endpoint.

You can access the API Gateway service to define API gateways and API deployments using the Console and
the REST API.

The API Gateway service is integrated with Oracle Cloud Infrastructure Identity and Access Management (IAM),
which provides easy authentication with native Oracle Cloud Infrastructure identity functionality.

Ways to Access Oracle Cloud Infrastructure

You can access Oracle Cloud Infrastructure using the Console (a browser-based interface) or the REST API.
Instructions for the Console and API are included in topics throughout this guide. For a list of available SDKs,
see Software Development Kits and Command Line Interface.

To access the Console, you must use a supported browser. You can use the Console link at the top of this
page to go to the sign-in page. You will be prompted to enter your cloud tenant, your user name, and your
password.

For general information about using the API, see REST APIs.

Resource Identifiers
Most types of Oracle Cloud Infrastructure resources have a unique, Oracle-assigned identifier called an Oracle
Cloud ID (OCID). For information about the OCID format and other ways to identify your resources, see
Resource Identifiers.

Authentication and Authorization

Each service in Oracle Cloud Infrastructure integrates with IAM for authentication and authorization, for all
interfaces (the Console, SDK or CLI, and REST API).

An administrator in your organization needs to set up groups  , compartments  , and policies  that
control which users can access which services, which resources, and the type of access. For example, the
policies control who can create new users, create and manage the cloud network, launch instances, create
buckets, download objects, etc. For more information, see Getting Started with Policies. For specific details
about writing policies for each of the different services, see Policy Reference.

If you’re a regular user (not an administrator) who needs to use the Oracle Cloud Infrastructure resources that
your company owns, contact your administrator to set up a user ID for you. The administrator can confirm
which compartment or compartments you should be using. /
API Gateway Capabilities and Limits
In each region that is enabled for your tenancy, you can create ten API gateways (Monthly Universal
Credits) or five API gateways (Pay-as-You-Go or Promo).

See Service Limits for a list of applicable limits and instructions for requesting a limit increase.

Some other API Gateway capabilities and limits are also fixed. However, there are also a number that you can
change. See API Gateway Internal Limits.

Required IAM Service Policy

To use Oracle Cloud Infrastructure, you must be given the required type of access in a policy  written by an
administrator, whether you're using the Console or the REST API with an SDK, CLI, or other tool. If you try to
perform an action and get a message that you don’t have permission or are unauthorized, confirm with your
administrator the type of access you've been granted and which compartment  you should work in.

If you're new to policies, see Getting Started with Policies and Common Policies.

For more details about policies for the API Gateway service, see:

Create Policies to Control Access to Network and API Gateway-Related Resources

Details for API Gateway

About Oracle ↪ | Contact Us ↪ | Legal Notices | Terms of Use ↪ | Privacy ↪ | Document Conventions | Cookie Preferences

Copyright © 2020, Oracle and/or its affiliates. All rights reserved.