Oracle API Gateway API
The apiGateway API from Oracle — 18 operation(s) for apigateway.
Oracle API Gateway API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include API Gateway. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 27 operations across 18 paths, and defines 73 schemas. It is described by OpenAPI 3.2.0, at version 20190501.
Requests are made against 2 base URLs: http://127.0.0.1/20190501, https://127.0.0.1/20190501.
27 operations
18 paths
73 schemas
3 DELETE10 GET11 POST3 PUT
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 27
Across 18 paths, the API surfaces 27 operations — 3 DELETE, 10 GET, 11 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
apiGateway 27
GET
/apis
Gets a list of all APIs in a compartment
POST
/apis
Creates a new API
DELETE
/apis/{apiId}
Delete an API.
GET
/apis/{apiId}
Get API
PUT
/apis/{apiId}
Update the API by the identifier
POST
/apis/{apiId}/actions/addLock
Adds a lock to a Api resource.
POST
/apis/{apiId}/actions/changeCompartment
Change the API compartment.
POST
/apis/{apiId}/actions/removeLock
Removes a lock to a Api resource.
GET
/apis/{apiId}/content
Get raw API content
GET
/apis/{apiId}/deploymentSpecification
Get API Deployment specification based on the API.
GET
/apis/{apiId}/validations
Get API content
GET
/certificates
Gets a list of all Certificates in a compartment
POST
/certificates
Creates a new Certificate
DELETE
/certificates/{certificateId}
Delete a provisioned Certificate
GET
/certificates/{certificateId}
Get Certificate
PUT
/certificates/{certificateId}
Update Certificate by the identifier
POST
/certificates/{certificateId}/actions/addLock
Adds a lock to a Certificate resource.
POST
/certificates/{certificateId}/actions/changeCompartment
Change the certificate compartment.
POST
/certificates/{certificateId}/actions/removeLock
Removes a lock to a Certificate resource.
GET
/sdkLanguageTypes
Lists available SDK target languages.
GET
/sdks
Lists SDKs
POST
/sdks
Creates an SDK
DELETE
/sdks/{sdkId}
Deletes SDK
GET
/sdks/{sdkId}
Downloadable link for the SDK.
PUT
/sdks/{sdkId}
Update the SDK by the identifier
POST
/sdks/{sdkId}/actions/addLock
Adds a lock to a Sdk resource.
POST
/sdks/{sdkId}/actions/removeLock
Removes a lock to a Sdk resource.
Schemas 73
The contract defines 73 schemas that model the data the API accepts and returns. The most detailed are Sdk (16 properties), Certificate (15 properties), ApiSummary (13 properties), CertificateSummary (13 properties). Each schema is shown below with its type and property counts.
UpdateSdkDetails
object
The information to be updated.
3 properties
RateLimitingPolicy
object
Limit the number of requests that should be handled for the specified window using a specfic key.
2 properties
2 required
RenameQueryParameterPolicyItem
object
The value will be a copy of the original value of the source parameter and will not be affected by any other transformation policies applied to that parameter.
2 properties
2 required
Error
object
Error Information.
2 properties
2 required
SetQueryParameterPolicyItem
object
Set will add a new query parameter if it was not in the original request. If the parameter already exists on the request, you can choose to override, append, o…
3 properties
2 required
CertificateCollection
object
Collection of certificate summaries.
1 property
1 required
MutualTlsDetails
object
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
2 properties
DynamicAuthenticationPolicy
object
Policy on how to authenticate requests when multiple authentication options are configured for a deployment. For an incoming request, the value of selector spe…
2 properties
2 required
ValidationRequestPolicy
object
Top-level validation policy mixin (not directly used).
1 property
RequestBodySizeValidationPolicy
object
Validate the size of the request body.
2 properties
RequestParameterValidation
object
Common parameter validation properties.
1 property
1 required
RenameHeaderPolicy
object
Rename HTTP headers as they pass through the gateway.
1 property
1 required
DynamicSelectionKey
object
Base policy for defining how to match the context variable in an incoming request with selection keys when dynamically routing and dynamically authenticating r…
3 properties
1 required
CertificateSummary
object
A summary of the certificate.
13 properties
6 required
QueryParameterValidationItem
Query parameter validation properties.
SetHeaderPolicyItem
object
Set will add a new header if it was not in the original request. If the header already exists on the request, you can choose to override, append, or skip it.
3 properties
2 required
SelectionSourcePolicy
object
The type of selector to use when dynamically routing and dynamically authenticating requests.
1 property
1 required
ApiValidationDetails
Detail of an error or warning.
CreateApiDetails
object
Information about the new API.
6 properties
1 required
HeaderTransformationPolicy
object
A set of transformations to apply to HTTP headers that pass through the gateway.
3 properties
ContentValidation
object
Content validation properties.
1 property
1 required
RemoveResourceLockDetails
object
Used to remove a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the reso…
1 property
1 required
ApiValidationResult
object
The result of single validation.
2 properties
2 required
UsagePlansPolicy
object
Usage plan policies for this deployment
1 property
1 required
RouteAuthorizationPolicy
object
If authentication has been performed, validate whether the request scope (if any) applies to this route. If no RouteAuthorizationPolicy is defined for a route,…
1 property
RenameQueryParameterPolicy
object
Rename parameters on the query string as they pass through the gateway.
1 property
1 required
ApiValidationDetail
object
Detail of a single error or warning.
3 properties
ChangeApiCompartmentDetails
object
The new compartment details for the API.
1 property
1 required
ExecutionLogPolicy
object
Configures the logging policies for the execution logs of an API Deployment.
2 properties
ResponseCacheLookupPolicy
object
Base policy for Response Cache lookup.
3 properties
1 required
SdkSummary
object
A summary of the SDK.
11 properties
4 required
ApiSpecificationRouteBackend
object
The backend to forward requests to.
1 property
1 required
SetHeaderPolicy
object
Set HTTP headers as they pass through the gateway.
1 property
1 required
AccessLogPolicy
object
Configures the logging policies for the access logs of an API Deployment.
1 property
CreateSdkDetails
object
Information about the new SDK.
7 properties
2 required
UpdateApiDetails
object
The information to be updated.
4 properties
SdkLanguageOptionalParametersAllowedValue
object
Allowed value object.
2 properties
CreateCertificateDetails
object
Information about a new certificate.
8 properties
3 required
QueryParameterTransformationPolicy
object
A set of transformations to apply to query parameters that pass through the gateway.
3 properties
SetQueryParameterPolicy
object
Set parameters on the query string as they pass through the gateway.
1 property
1 required
ApiSpecificationRoute
object
A single route that forwards requests to a particular backend and may contain some additional policies.
6 properties
2 required
Certificate
object
A certificate contains information to be installed on a gateway to secure the traffic going through it. For more information, see [API Gateway Concepts](/iaas/…
15 properties
7 required
UpdateCertificateDetails
object
The information to be updated.
3 properties
SdkLanguageOptionalParameters
object
List of additional applicable parameters for any given target language.
7 properties
1 required
SdkLanguageTypeCollection
object
Collection of available SDK target languages.
1 property
1 required
FilterHeaderPolicy
object
Filter HTTP headers as they pass through the gateway. The gateway applies filters after other transformations, so any headers set or renamed must also be liste…
2 properties
2 required
SdkCollection
object
Collection of the existing SDKs.
1 property
1 required
ApiSummary
object
A summary of the API.
13 properties
2 required
BodyValidationRequestPolicy
Validate the payload body of the incoming API requests on a specific route.
AuthenticationServerPolicy
object
Policy for the details regarding each authentication server under dynamic authentication. We specify the value of selectors for which this authentication serve…
2 properties
2 required
ApiSpecification
object
The logical configuration of the API exposed by a deployment.
3 properties
HeaderValidationItem
Header validation properties.
Api
An API is simple container for an API Specification. For more information, see [API Gateway Concepts](/iaas/Content/APIGateway/Concepts/apigatewayconcepts.htm).
ApiSpecificationRouteResponsePolicies
object
Behavior applied to any responses sent by the API for requests on this route.
2 properties
FilterHeaderPolicyItem
object
A header to drop (with BLOCK) or pass through (with ALLOW).
1 property
1 required
ResourceLock
object
Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resource and deleting the resource.…
4 properties
1 required
SdkLanguageTypeSummary
object
SDK target language details.
5 properties
2 required
ResponseCacheStorePolicy
object
Base policy for how a response from a backend is cached in the Response Cache.
1 property
1 required
ApiCollection
object
Collection of API summaries.
1 property
1 required
ChangeCertificateCompartmentDetails
object
The new compartment details for the certificate.
1 property
1 required
HeaderValidationRequestPolicy
Validate the HTTP headers on the incoming API requests on a specific route.
CorsPolicy
object
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
6 properties
1 required
RenameHeaderPolicyItem
object
The value will be a copy of the original value of the source header and will not be affected by any other transformation policies applied to that header.
2 properties
2 required
ApiSpecificationRouteRequestPolicies
object
Behavior applied to any requests received by the API on this route.
9 properties
Sdk
object
Information about the SDK.
16 properties
4 required
ApiValidations
object
The result of validations conducted on the API.
1 property
1 required
FilterQueryParameterPolicyItem
object
A query parameter to drop (with BLOCK) or pass through (with ALLOW).
1 property
1 required
AuthenticationPolicy
object
Information on how to authenticate incoming requests.
2 properties
1 required
FilterQueryParameterPolicy
object
Filter parameters from the query string as they pass through the gateway. The gateway applies filters after other transformations, so any parameters set or ren…
2 properties
2 required
AddResourceLockDetails
object
Used to add a resource lock. Resource locks are used to prevent certain APIs from being called for the resource. A full lock prevents both updating the resourc…
2 properties
1 required
QueryParameterValidationRequestPolicy
Validate the URL query parameters on the incoming API requests on a specific route.
ApiSpecificationRequestPolicies
object
Global behavior applied to all requests received by the API.
7 properties
ApiSpecificationLoggingPolicies
object
Policies controlling the pushing of logs to OCI Public Logging.
2 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Oracle 12
Other APIs Oracle publishes across the network.
Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
#API Gateway
Where this information came from
This is an independent, third-party profile of Oracle API Gateway API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.