Oracle Deployment API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes
8 operations
across 5 paths,
and defines 54 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.
The identity and technical contract details declared by the specification.
ApiSpecificationRouteResponsePolicies
object
Behavior applied to any responses sent by the API for requests on this route.
2 properties
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
UpdateDeploymentDetails
object
The information to be updated.
4 properties
AccessLogPolicy
object
Configures the logging policies for the access logs of an API Deployment.
1 property
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
RenameHeaderPolicy
object
Rename HTTP headers as they pass through the gateway.
1 property
1 required
RequestParameterValidation
object
Common parameter validation properties.
1 property
1 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
BodyValidationRequestPolicy
Validate the payload body of the incoming API requests on a specific route.
CreateDeploymentDetails
object
Information about a new deployment.
8 properties
4 required
MutualTlsDetails
object
Properties used to configure client mTLS verification when API Consumer makes connection to the gateway.
2 properties
ApiSpecificationLoggingPolicies
object
Policies controlling the pushing of logs to OCI Public Logging.
2 properties
CorsPolicy
object
Enable CORS (Cross-Origin-Resource-Sharing) request handling.
6 properties
1 required
RequestBodySizeValidationPolicy
object
Validate the size of the request body.
2 properties
AuthenticationPolicy
object
Information on how to authenticate incoming requests.
2 properties
1 required
ExecutionLogPolicy
object
Configures the logging policies for the execution logs of an API Deployment.
2 properties
UsagePlansPolicy
object
Usage plan policies for this deployment
1 property
1 required
ResponseCacheLookupPolicy
object
Base policy for Response Cache lookup.
3 properties
1 required
ApiSpecificationRouteBackend
object
The backend to forward requests to.
1 property
1 required
QueryParameterValidationItem
Query parameter validation properties.
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
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
SetQueryParameterPolicy
object
Set parameters on the query string as they pass through the gateway.
1 property
1 required
ApiSpecification
object
The logical configuration of the API exposed by a deployment.
3 properties
ResponseCacheStorePolicy
object
Base policy for how a response from a backend is cached in the Response Cache.
1 property
1 required
ContentValidation
object
Content validation properties.
1 property
1 required
DeploymentSummary
object
A summary of the deployment.
14 properties
5 required
ChangeDeploymentCompartmentDetails
object
The new compartment details for the deployment.
1 property
1 required
ApiSpecificationRouteRequestPolicies
object
Behavior applied to any requests received by the API on this route.
9 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
FilterQueryParameterPolicyItem
object
A query parameter to drop (with BLOCK) or pass through (with ALLOW).
1 property
1 required
FilterHeaderPolicyItem
object
A header to drop (with BLOCK) or pass through (with ALLOW).
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
DeploymentCollection
object
Collection of deployment summaries.
1 property
1 required
ApiSpecificationRequestPolicies
object
Global behavior applied to all requests received by the API.
7 properties
ValidationRequestPolicy
object
Top-level validation policy mixin (not directly used).
1 property
RateLimitingPolicy
object
Limit the number of requests that should be handled for the specified window using a specfic key.
2 properties
2 required
QueryParameterTransformationPolicy
object
A set of transformations to apply to query parameters that pass through the gateway.
3 properties
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
QueryParameterValidationRequestPolicy
Validate the URL query parameters on the incoming API requests on a specific route.
Error
object
Error Information.
2 properties
2 required
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
RenameQueryParameterPolicy
object
Rename 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
HeaderTransformationPolicy
object
A set of transformations to apply to HTTP headers that pass through the gateway.
3 properties
HeaderValidationRequestPolicy
Validate the HTTP headers on the incoming API requests on a specific route.
HeaderValidationItem
Header validation properties.
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
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
Deployment
object
A deployment deploys an API on a gateway. Avoid entering confidential information. For more information, see [API Gateway Concepts](/iaas/Content/APIGateway/Co…
15 properties
6 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
SetHeaderPolicy
object
Set HTTP headers as they pass through the gateway.
1 property
1 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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Oracle publishes across the network.
