Apigateway

oci.apigateway.ApiGatewayClient API for the API Gateway service.
oci.apigateway.DeploymentClient API for the API Gateway service.
oci.apigateway.GatewayClient API for the API Gateway service.
oci.apigateway.WorkRequestsClient API for the API Gateway service.
oci.apigateway.ApiGatewayClientCompositeOperations This class provides a wrapper around ApiGatewayClient and offers convenience methods for operations that would otherwise need to be chained together.
oci.apigateway.DeploymentClientCompositeOperations This class provides a wrapper around DeploymentClient and offers convenience methods for operations that would otherwise need to be chained together.
oci.apigateway.GatewayClientCompositeOperations This class provides a wrapper around GatewayClient and offers convenience methods for operations that would otherwise need to be chained together.
oci.apigateway.WorkRequestsClientCompositeOperations This class provides a wrapper around WorkRequestsClient and offers convenience methods for operations that would otherwise need to be chained together.

Models

oci.apigateway.models.AccessLogPolicy Configures the logging policies for the access logs of an API Deployment.
oci.apigateway.models.AnonymousRouteAuthorizationPolicy For a type of ANONYMOUS, an authenticated API must have the “isAnonymousAccessAllowed” property set to “true” in the authentication policy.
oci.apigateway.models.AnyOfRouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
oci.apigateway.models.Api An API is simple container for an API Specification.
oci.apigateway.models.ApiCollection Collection of API summaries.
oci.apigateway.models.ApiSpecification The logical configuration of the API exposed by a deployment.
oci.apigateway.models.ApiSpecificationLoggingPolicies Policies controlling the pushing of logs to OCI Public Logging.
oci.apigateway.models.ApiSpecificationRequestPolicies Global behavior applied to all requests received by the API.
oci.apigateway.models.ApiSpecificationRoute A single route that forwards requests to a particular backend and may contain some additional policies.
oci.apigateway.models.ApiSpecificationRouteBackend The backend to forward requests to.
oci.apigateway.models.ApiSpecificationRouteRequestPolicies Behavior applied to any requests received by the API on this route.
oci.apigateway.models.ApiSpecificationRouteResponsePolicies Behavior applied to any responses sent by the API for requests on this route.
oci.apigateway.models.ApiSummary A summary of the API.
oci.apigateway.models.ApiValidationDetail Detail of a single error or warning.
oci.apigateway.models.ApiValidationDetails Detail of an error or warning.
oci.apigateway.models.ApiValidationResult The result of single validation.
oci.apigateway.models.ApiValidations The result of validations conducted on the API.
oci.apigateway.models.AuthenticationOnlyRouteAuthorizationPolicy Only authentication is performed for the request and authorization is skipped.
oci.apigateway.models.AuthenticationPolicy Information on how to authenticate incoming requests.
oci.apigateway.models.BodyValidationRequestPolicy Validate the payload body of the incoming API requests on a specific route.
oci.apigateway.models.Certificate A certificate contains information to be installed on a gateway to secure the traffic going through it.
oci.apigateway.models.CertificateCollection Collection of certificate summaries.
oci.apigateway.models.CertificateSummary A summary of the certificate.
oci.apigateway.models.ChangeApiCompartmentDetails The new compartment details for the API.
oci.apigateway.models.ChangeCertificateCompartmentDetails The new compartment details for the certificate.
oci.apigateway.models.ChangeDeploymentCompartmentDetails The new compartment details for the deployment.
oci.apigateway.models.ChangeGatewayCompartmentDetails The new compartment details for the gateway.
oci.apigateway.models.ContentValidation Content validation properties.
oci.apigateway.models.CorsPolicy Enable CORS (Cross-Origin-Resource-Sharing) request handling.
oci.apigateway.models.CreateApiDetails Information about the new API.
oci.apigateway.models.CreateCertificateDetails Information about a new certificate.
oci.apigateway.models.CreateDeploymentDetails Information about a new deployment.
oci.apigateway.models.CreateGatewayDetails Information about the new gateway.
oci.apigateway.models.CreateSdkDetails Information about the new SDK.
oci.apigateway.models.CustomAuthenticationPolicy Use a function to validate a custom header or query parameter sent with the request authentication.
oci.apigateway.models.Deployment A deployment deploys an API on a gateway.
oci.apigateway.models.DeploymentCollection Collection of deployment summaries.
oci.apigateway.models.DeploymentSummary A summary of the deployment.
oci.apigateway.models.ExecutionLogPolicy Configures the logging policies for the execution logs of an API Deployment.
oci.apigateway.models.ExternalRespCache Connection details for an external RESP based cache store for Response Caching.
oci.apigateway.models.FilterHeaderPolicy Filter HTTP headers as they pass through the gateway.
oci.apigateway.models.FilterHeaderPolicyItem A header to drop (with BLOCK) or pass through (with ALLOW).
oci.apigateway.models.FilterQueryParameterPolicy Filter parameters from the query string as they pass through the gateway.
oci.apigateway.models.FilterQueryParameterPolicyItem A query parameter to drop (with BLOCK) or pass through (with ALLOW).
oci.apigateway.models.FixedTTLResponseCacheStorePolicy How a response from a backend is cached in the Response Cache.
oci.apigateway.models.Gateway A gateway is a virtual network appliance in a regional subnet.
oci.apigateway.models.GatewayCollection Collection of gateway summaries.
oci.apigateway.models.GatewaySummary A summary of the gateway.
oci.apigateway.models.HTTPBackend Send the request to an HTTP backend.
oci.apigateway.models.HeaderFieldSpecification Header in key/value pair.
oci.apigateway.models.HeaderTransformationPolicy A set of transformations to apply to HTTP headers that pass through the gateway.
oci.apigateway.models.HeaderValidationItem Header validation properties.
oci.apigateway.models.HeaderValidationRequestPolicy Validate the HTTP headers on the incoming API requests on a specific route.
oci.apigateway.models.IpAddress IP address associated with the gateway.
oci.apigateway.models.JsonWebKey A JSON Web Key that represents the public key used for verifying the JWT signature.
oci.apigateway.models.JsonWebTokenClaim An individual JWT claim.
oci.apigateway.models.JwtAuthenticationPolicy Validate a JWT token present in the header or query parameter.
oci.apigateway.models.NoCache Configures the gateway with no caching.
oci.apigateway.models.NoContentValidation No content validation properties.
oci.apigateway.models.OracleFunctionBackend Send the request to an Oracle Functions function.
oci.apigateway.models.PemEncodedPublicKey A PEM-encoded public key used for verifying the JWT signature.
oci.apigateway.models.PublicKeySet A set of Public Keys that will be used to verify the JWT signature.
oci.apigateway.models.QueryParameterTransformationPolicy A set of transformations to apply to query parameters that pass through the gateway.
oci.apigateway.models.QueryParameterValidationItem Query parameter validation properties.
oci.apigateway.models.QueryParameterValidationRequestPolicy Validate the URL query parameters on the incoming API requests on a specific route.
oci.apigateway.models.RateLimitingPolicy Limit the number of requests that should be handled for the specified window using a specfic key.
oci.apigateway.models.RemoteJsonWebKeySet A set of public keys that is retrieved at run-time from a remote location to verify the JWT signature.
oci.apigateway.models.RenameHeaderPolicy Rename HTTP headers as they pass through the gateway.
oci.apigateway.models.RenameHeaderPolicyItem 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.
oci.apigateway.models.RenameQueryParameterPolicy Rename parameters on the query string as they pass through the gateway.
oci.apigateway.models.RenameQueryParameterPolicyItem 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.
oci.apigateway.models.RequestParameterValidation Common parameter validation properties.
oci.apigateway.models.ResponseCacheDetails Base Gateway response cache.
oci.apigateway.models.ResponseCacheLookupPolicy Base policy for Response Cache lookup.
oci.apigateway.models.ResponseCacheRespServer Details of a RESP based cache store server
oci.apigateway.models.ResponseCacheStorePolicy Base policy for how a response from a backend is cached in the Response Cache.
oci.apigateway.models.RouteAuthorizationPolicy If authentication has been performed, validate whether the request scope (if any) applies to this route.
oci.apigateway.models.Sdk Information about the SDK.
oci.apigateway.models.SdkCollection Collection of the existing SDKs.
oci.apigateway.models.SdkLanguageOptionalParameters List of additional applicable parameters for any given target language.
oci.apigateway.models.SdkLanguageOptionalParametersAllowedValue Allowed value object.
oci.apigateway.models.SdkLanguageTypeCollection Collection of available SDK target languages.
oci.apigateway.models.SdkLanguageTypeSummary SDK target language details.
oci.apigateway.models.SdkLanguageTypes SDK target language details.
oci.apigateway.models.SdkSummary A summary of the SDK.
oci.apigateway.models.SetHeaderPolicy Set HTTP headers as they pass through the gateway.
oci.apigateway.models.SetHeaderPolicyItem Set will add a new header if it was not in the original request.
oci.apigateway.models.SetQueryParameterPolicy Set parameters on the query string as they pass through the gateway.
oci.apigateway.models.SetQueryParameterPolicyItem Set will add a new query parameter if it was not in the original request.
oci.apigateway.models.SimpleLookupPolicy Provides ability to vary the cache key using context expressions.
oci.apigateway.models.StaticPublicKey A static public key which is used to verify the JWT signature.
oci.apigateway.models.StaticPublicKeySet A set of static public keys that will be used to verify the JWT signature.
oci.apigateway.models.StockResponseBackend Send the request to a mock backend.
oci.apigateway.models.UpdateApiDetails The information to be updated.
oci.apigateway.models.UpdateCertificateDetails The information to be updated.
oci.apigateway.models.UpdateDeploymentDetails The information to be updated.
oci.apigateway.models.UpdateGatewayDetails The information to be updated.
oci.apigateway.models.UpdateSdkDetails The information to be updated.
oci.apigateway.models.ValidationRequestPolicy Top-level validation policy mixin (not directly used).
oci.apigateway.models.WorkRequest A description of the work request status.
oci.apigateway.models.WorkRequestCollection Collection of work request summaries.
oci.apigateway.models.WorkRequestError An error encountered while executing a work request.
oci.apigateway.models.WorkRequestErrorCollection Collection of work request errors.
oci.apigateway.models.WorkRequestLog A log message from the execution of a work request.
oci.apigateway.models.WorkRequestLogCollection Collection of work request logs.
oci.apigateway.models.WorkRequestResource A resource created or operated on by a work request.
oci.apigateway.models.WorkRequestSummary A summary of the work request.