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 API 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 OCI Functions) into a single consolidated API endpoint.

Use the Oracle Cloud integration to discover and collect metrics against the OCI API Gateways.


To set up the Oracle Cloud integration and discover the OCI API Gateways service, do the following:

  1. Create a Oracle Cloud (OCI) integration if not available in your installed integrations.

  2. You can select OCI API Gateways during integration or you can edit the existing integration and select OCI API Gateways.

  3. Scan to discover the resources at any time independent of the predefined schedule.

  4. Once the scan is completed, you can view the OCI API Gateways resource under Infrastructure > Resources > Oracle Cloud category.

  5. Create a template. See Create a Template for more information on how to create a template.

  6. Refer to Assign a Template on how to assign a template to a resource.

  7. Click the Metrics tab to view the monitoring data of OCI API Gateways as shown below:

Supported metrics

OpsRamp MetricOracle Cloud MetricMetric Display NameUnitDescriptionAggregation Type
oci_apigateway_BackendHttpResponsesBackendHttpResponsesBackend ResponsescountCount of the HTTP responses returned by the back-end services.sum
oci_apigateway_BytesReceivedBytesReceivedBytes ReceivedbytesNumber of bytes received by the API gateway from API clients.sum
oci_apigateway_BytesSentBytesSentBytes SentbytesNumber of bytes sent by the API gateway to API clients.sum
oci_apigateway_HttpRequestsHttpRequestsAPI RequestscountNumber of incoming API client requests to the API gateway.sum
oci_apigateway_HttpResponsesHttpResponsesAPI ResponsescountNumber of http responses that the API gateway has sent back.sum
oci_apigateway_IntegrationLatencyIntegrationLatencyBackend LatencysecondsTime between the API gateway sending a request to the back-end service and receiving a response from the back-end service.mean
oci_apigateway_InternalLatencyInternalLatencyInternal LatencysecondsTime spent internally in the API gateway to process the request.mean
oci_apigateway_LatencyLatencyGateway LatencysecondsTime taken by a request to be processed and the response to be sent. This is calculated from the time the API gateway receives the first byte of an HTTP request to the time when the response send operation is completed.mean
oci_apigateway_ResponseCacheAvailabilityResponseCacheAvailabilityResponse Cache AvailabilitycountAvailability of the response cache as seen by the API gateway.sum