openapi: 3.2.0 info: description: 'API for the Web Application Acceleration service. Use this API to manage regional Web App Acceleration policies such as Caching and Compression for accelerating HTTP services. ' title: Web Application Acceleration () Waa API version: '20211230' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/dc50b70d5c21d1298bd664f84320e70f07773ce71609749110f8da3201c5e45b.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Web Application Acceleration (WAA) API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/dc50b70d5c21d1298bd664f84320e70f07773ce71609749110f8da3201c5e45b.yaml what: the harvested document for Web Application Acceleration (WAA) API servers: - url: http://127.0.0.1/20211230 - url: https://127.0.0.1/20211230 tags: - name: waa paths: /webAppAccelerationPolicies: get: description: 'Gets a list of all WebAppAccelerationPolicies in a compartment. ' operationId: ListWebAppAccelerationPolicies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WebAppAccelerationPolicyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/WebAppAccelerationPolicyIdentifierQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of WebAppAccelerationPolicySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAccelerationPolicyCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of WebAppAccelerationPolicies. tags: - waa x-example: 'GET /20211230/webAppAccelerationPolicies?compartmentId={compartmentId}&displayName={displayName}&sortOrder=DESC Host: waa.us-phoenix-1.oraclecloud.com ' x-related-resource: '#/definitions/WebAppAccelerationPolicy' post: description: 'Creates a new WebAppAccelerationPolicy. ' operationId: CreateWebAppAccelerationPolicy parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The WebAppAccelerationPolicy will be created. headers: content-location: description: 'Content Location of the resource. ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Location of the resource. ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAccelerationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new WebAppAccelerationPolicy. tags: - waa x-example: "POST /20211230/webAppAccelerationPolicies\nHost: waa.us-phoenix-1.oraclecloud.com\n{\n \"compartmentId\": \"{{compartmentId}}\",\n \"displayName\": \"WAAPolicy1\",\n \"responseCachingPolicy\":{},\n \"responseCompressionPolicy\":{},\n \"freeformTags\": {\n \"foo\": \"bar\"\n }\n}\n" x-related-resource: '#/definitions/WebAppAccelerationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWebAppAccelerationPolicyDetails' description: Details for the new WebAppAccelerationPolicy. required: true /webAppAccelerationPolicies/{webAppAccelerationPolicyId}: delete: description: Deletes a WebAppAccelerationPolicy resource identified by the OCID. operationId: DeleteWebAppAccelerationPolicy parameters: - $ref: '#/components/parameters/WebAppAccelerationPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAccelerationPolicy will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned WebAppAccelerationPolicy. tags: - waa x-example: 'GET /20211230/webAppAccelerationPolicies/{webAppAccelerationPolicyId} Host: waa.us-phoenix-1.oraclecloud.com ' x-related-resource: '#/definitions/WebAppAccelerationPolicy' get: description: Gets a WebAppAccelerationPolicy with the given OCID. operationId: GetWebAppAccelerationPolicy parameters: - $ref: '#/components/parameters/WebAppAccelerationPolicyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the WebAppAccelerationPolicy with the given OCID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAccelerationPolicy' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get WebAppAccelerationPolicy. tags: - waa x-example: 'GET /20211230/webAppAccelerationPolicies/{webAppAccelerationPolicyId} Host: waa.us-phoenix-1.oraclecloud.com ' put: description: Update the WebAppAccelerationPolicy identified by the OCID. operationId: UpdateWebAppAccelerationPolicy parameters: - $ref: '#/components/parameters/WebAppAccelerationPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAccelerationPolicy will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the WebAppAccelerationPolicy. tags: - waa x-example: "PUT /20211230/webAppAccelerationPolicies/{webAppAccelerationPolicyId}\nHost: waa.us-phoenix-1.oraclecloud.com\n{\n \"displayName\": \"WaaPolicy_IDidntChangeMyName_8579167\",\n \"responseCachingPolicy\": {},\n \"responseCompressionPolicy\": null,\n \"freeformTags\": {\n \"foo\": \"bar\"\n }\n}\n" x-related-resource: '#/definitions/WebAppAccelerationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWebAppAccelerationPolicyDetails' description: The information to be updated. required: true /webAppAccelerationPolicies/{webAppAccelerationPolicyId}/actions/changeCompartment: post: description: 'Moves a WebAppAccelerationfPolicy resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeWebAppAccelerationPolicyCompartment parameters: - $ref: '#/components/parameters/WebAppAccelerationPolicyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAccelerationPolicy resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - waa x-example: "POST /20211230/webAppAccelerationPolicies/{webAppAccelerationPolicyId}/actions/changeCompartment\nHost: waa.us-phoenix-1.oraclecloud.com\n{\n \"compartmentId\": \"{{newCompartmentId}}\"\n}\n" x-related-resource: '#/definitions/WebAppAccelerationPolicy' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeWebAppAccelerationPolicyCompartmentDetails' description: The information to be updated. required: true /webAppAccelerations: get: description: 'Gets a list of all WebAppAccelerations in a compartment. ' operationId: ListWebAppAccelerations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/WebAppAccelerationIdentifierQueryParam' - $ref: '#/components/parameters/WebAppAccelerationWebAppAccelerationPolicyIdentifierQueryParam' - $ref: '#/components/parameters/WebAppAccelerationLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of WebAppAccelerationSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAccelerationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Returns a list of WebAppAccelerations. tags: - waa x-example: 'GET /20211230/webAppAccelerations?compartmentId={compartmentId}&displayName={displayName}&sortOrder=DESC Host: waa.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/WebAppAcceleration' post: description: 'Creates a new WebAppAcceleration. ' operationId: CreateWebAppAcceleration parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 201: description: Accepted the request. The WebAppAcceleration will be created. headers: content-location: description: 'Content Location of the resource. ' schema: type: string format: uri-reference etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string location: description: 'Location of the resource. ' schema: type: string format: uri-reference opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAcceleration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates a new WebAppAcceleration. tags: - waa x-example: "POST /20211230/webAppAccelerations\nHost: waa.us-phoenix-1.oci.oraclecloud.com\n{\n \"compartmentId\": \"{{compartmentId}}\",\n \"displayName\": \"WAA1\",\n \"webAppAccelerationPolicyId\": \"ocid1.webappfirewallpolicy.oc1.phx.amaaaaaayhrfuyya4kumkrotgkqkb4663f3oszlugeyy46kxr5chtbmflhfq\",\n \"backendType\": \"LOAD_BALANCER\",\n \"loadBalancerId\": \"ocid1.loadbalancer.oc1.phx.aaaaaaaazgaxi53skqcmejpfwtdfz2ilqwj43nzruo7voybxapcwwu4pss4q\",\n \"freeformTags\": {\n \"foo\": \"bar\"\n }\n}\n" x-related-resource: '#/definitions/WebAppAcceleration' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateWebAppAccelerationDetails' description: Details for the new WebAppAcceleration. required: true /webAppAccelerations/{webAppAccelerationId}: delete: description: Deletes a WebAppAcceleration resource identified by the OCID. operationId: DeleteWebAppAcceleration parameters: - $ref: '#/components/parameters/WebAppAccelerationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAcceleration will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a provisioned WebAppAcceleration. tags: - waa x-example: 'DELETE /20211230/webAppAccelerations/{webAppAccelerationId} Host: waa.us-phoenix-1.oci.oraclecloud.com ' x-related-resource: '#/definitions/WebAppAcceleration' get: description: Gets a WebAppAcceleration by OCID. operationId: GetWebAppAcceleration parameters: - $ref: '#/components/parameters/WebAppAccelerationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the WebAppAcceleration with the given OCID. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WebAppAcceleration' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get WebAppAcceleration. tags: - waa x-example: 'GET /20211230/webAppAccelerations/{webAppAccelerationId} Host: waa.us-phoenix-1.oci.oraclecloud.com ' put: description: Updates the WebAppAcceleration identified by the OCID. operationId: UpdateWebAppAcceleration parameters: - $ref: '#/components/parameters/WebAppAccelerationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAcceleration will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update the WebAppAcceleration. tags: - waa x-example: "PUT /20211230/webAppAccelerations/{webAppAccelerationId}\nHost: waa.us-phoenix-1.oci.oraclecloud.com\n {\n \"compartmentId\": \"{{compartmentId}}\",\n \"displayName\": \"WAA1\",\n \"webAppAccelerationPolicyId\": \"ocid1.webappacceleration.oc1.phx.amaaaaaayhrfuyya4kumkrotgkqkb4663f3oszlugeyy46kxr5chtbmflhfq\",\n \"backendType\": \"LOAD_BALANCER\",\n \"loadBalancerId\": \"ocid1.loadbalancer.oc1.phx.aaaaaaaazgaxi53skqcmejpfwtdfz2ilqwj43nzruo7voybxapcwwu4pss4q\",\n \"freeformTags\": {\n \"foo\": \"bar\"\n }\n }\n" x-related-resource: '#/definitions/WebAppAcceleration' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateWebAppAccelerationDetails' description: The information to be updated. required: true /webAppAccelerations/{webAppAccelerationId}/actions/changeCompartment: post: description: 'Moves a Web App Acceleration resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangeWebAppAccelerationCompartment parameters: - $ref: '#/components/parameters/WebAppAccelerationIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAcceleration resource will be moved into a different compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Moves a resource into a different compartment. tags: - waa x-example: "POST /20211230/webAppAccelerations/{webAppAccelerationId}/actions/changeCompartment\nHost: waa.us-phoenix-1.oci.oraclecloud.com\n{\n \"compartmentId\": \"{{newCompartmentId}}\"\n}\n" x-related-resource: '#/definitions/WebAppAcceleration' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeWebAppAccelerationCompartmentDetails' description: The information to be updated. required: true /webAppAccelerations/{webAppAccelerationId}/actions/purgeCache: post: description: 'Clears resources from the cache of the WebAppAcceleration. Each new request for a purged resource will be forwarded to the origin server to fetch a new version of the resource. ' operationId: PurgeWebAppAccelerationCache parameters: - $ref: '#/components/parameters/WebAppAccelerationIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The WebAppAcceleration cache will be purged. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Purges WebAppAcceleration cache. tags: - waa x-example: "POST /20211230/webAppAccelerationPolicies/{webAppAccelerationPolicyId}/actions/purgeCache\nHost: waa.us-phoenix-1.oci.oraclecloud.com\n{\n \"purgeType\": \"ENTIRE_CACHE\"\n}\n" x-related-resource: '#/definitions/WebAppAcceleration' requestBody: content: application/json: schema: $ref: '#/components/schemas/PurgeWebAppAccelerationCacheDetails' description: Options for the cache purge. required: true components: parameters: WebAppAccelerationWebAppAccelerationPolicyIdentifierQueryParam: description: 'A filter to return only the WebAppAcceleration with the given [OCID](/Content/General/Concepts/identifiers.htm) of related WebAppAccelerationPolicy. ' in: query name: webAppAccelerationPolicyId x-default-description: 'null' schema: type: string PaginationTokenQueryParam: description: 'A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. ' in: query name: page schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated WebAppAccelerationLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string x-obmcs-enumref: '#/definitions/WebAppAcceleration/lifecycleState' CompartmentIdQueryParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string WebAppAccelerationPolicyLifecycleStateQueryParam: description: A filter to return only resources that match the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' style: form explode: true schema: type: array items: type: string x-obmcs-enumref: '#/definitions/WebAppAccelerationPolicy/lifecycleState' PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 100 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC WebAppAccelerationIdentifierPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAcceleration. in: path name: webAppAccelerationId required: true schema: type: string WebAppAccelerationPolicyIdentifierPathParam: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAccelerationPolicy. in: path name: webAppAccelerationPolicyId required: true schema: type: string WebAppAccelerationIdentifierQueryParam: description: A filter to return only the WebAppAcceleration with the given [OCID](/Content/General/Concepts/identifiers.htm). in: query name: id x-default-description: 'null' schema: type: string RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string WebAppAccelerationPolicyIdentifierQueryParam: description: A filter to return only the WebAppAccelerationPolicy with the given [OCID](/Content/General/Concepts/identifiers.htm). in: query name: id x-default-description: 'null' schema: type: string schemas: ResponseCachingPolicy: description: 'An object that specifies an HTTP response caching policy. ' properties: isResponseHeaderBasedCachingEnabled: default: false description: 'When false, responses will not be cached by the backend based on response headers. When true, responses that contain one of the supported cache control headers will be cached according to the values specified in the cache control headers. The "X-Accel-Expires" header field sets caching time of a response in seconds. The zero value disables caching for a response. If the value starts with the @ prefix, it sets an absolute time in seconds since Epoch, up to which the response may be cached. If the header does not include the "X-Accel-Expires" field, parameters of caching may be set in the header fields "Expires" or "Cache-Control". If the header includes the "Set-Cookie" field, such a response will not be cached. If the header includes the "Vary" field with the special value "*", such a response will not be cached. If the header includes the "Vary" field with another value, such a response will be cached taking into account the corresponding request header fields. ' type: boolean type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message ChangeWebAppAccelerationPolicyCompartmentDetails: description: Updates compartmentId of resource. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WebAppAccelerationSummary: description: Summary of the WebAppAcceleration. discriminator: propertyName: backendType properties: backendType: description: Type of the WebAppAcceleration, as example LOAD_BALANCER. enum: - LOAD_BALANCER type: string x-obmcs-top-level-enum: '#/definitions/BackendType' compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAcceleration display name, can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAcceleration. type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. ' type: string lifecycleState: description: The current state of the WebAppAcceleration. type: string x-obmcs-enumref: '#/definitions/WebAppAcceleration/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the WebAppAcceleration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the WebAppAcceleration was updated. An RFC3339 formatted datetime string. format: date-time type: string webAppAccelerationPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of WebAppAccelerationPolicy, which is attached to the resource. type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags - backendType - webAppAccelerationPolicyId type: object CreateWebAppAccelerationPolicyDetails: description: The information about new WebAppAccelerationPolicy. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAccelerationPolicy display name, can be renamed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object responseCachingPolicy: $ref: '#/components/schemas/ResponseCachingPolicy' responseCompressionPolicy: $ref: '#/components/schemas/ResponseCompressionPolicy' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object required: - compartmentId type: object ResponseCompressionPolicy: description: 'An object that specifies a compression policy for HTTP response from ENABLEMENT POINT to the client. This compression policy can be used to enable support for HTTP response compression algorithms like gzip and configure the conditions of when a compression algorithm will be used. HTTP responses will only be compressed if the client indicates support for one of the enabled compression algorithms via the "Accept-Encoding" request header. ' properties: gzipCompression: $ref: '#/components/schemas/GzipCompressionPolicy' type: object WebAppAccelerationPolicySummary: description: Summary of the WebAppAccelerationPolicy. properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAccelerationPolicy display name, can be renamed. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAccelerationPolicy. type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. ' type: string lifecycleState: description: The current state of the WebAppAccelerationPolicy. type: string x-obmcs-enumref: '#/definitions/WebAppAccelerationPolicy/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags type: object WebAppAccelerationPolicyCollection: description: Contains WebAppAccelerationPolicySummary items. properties: items: description: A list of WebAppAccelerationPolicySummary objects. items: $ref: '#/components/schemas/WebAppAccelerationPolicySummary' type: array required: - items type: object UpdateWebAppAccelerationPolicyDetails: description: 'The information to be updated. When updating WebAppAccelerationPolicy, shallow merge is used for all top-level fields, meaning that top-level fields with defined values are completely overwritten and top-level fields without defined values are unchanged. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAccelerationPolicy display name, can be renamed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object responseCachingPolicy: $ref: '#/components/schemas/ResponseCachingPolicy' responseCompressionPolicy: $ref: '#/components/schemas/ResponseCompressionPolicy' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object type: object WebAppAccelerationPolicy: description: "The details of WebAppAccelerationPolicy. A policy is comprised of rules, which allows enablement of Caching \nand Compression of HTTP response.\nCaching can be enabled for a particular path\nCompression is enabled at global level\n" properties: compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAccelerationPolicy display name, can be renamed. maxLength: 1024 minLength: 0 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAccelerationPolicy. type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. ' type: string lifecycleState: description: The current state of the WebAppAccelerationPolicy. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string responseCachingPolicy: $ref: '#/components/schemas/ResponseCachingPolicy' responseCompressionPolicy: $ref: '#/components/schemas/ResponseCompressionPolicy' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the WebAppAccelerationPolicy was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the WebAppAccelerationPolicy was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags type: object WebAppAcceleration: description: A resource connecting a WebAppAccelerationPolicy to a backend of particular type, applying that policy's coverage to the backend. discriminator: propertyName: backendType properties: backendType: description: Type of the WebAppAcceleration, as example LOAD_BALANCER. enum: - LOAD_BALANCER type: string x-obmcs-top-level-enum: '#/definitions/BackendType' compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAcceleration display name, can be renamed. maxLength: 1024 minLength: 0 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the WebAppAcceleration. type: string lifecycleDetails: description: 'A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in FAILED state. ' type: string lifecycleState: description: The current state of the WebAppAcceleration. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The time the WebAppAcceleration was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the WebAppAcceleration was updated. An RFC3339 formatted datetime string. format: date-time type: string webAppAccelerationPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of WebAppAccelerationPolicy, which is attached to the resource. type: string required: - id - compartmentId - displayName - timeCreated - lifecycleState - freeformTags - definedTags - systemTags - backendType - webAppAccelerationPolicyId type: object CreateWebAppAccelerationDetails: description: The information about new WebAppAcceleration. discriminator: propertyName: backendType properties: backendType: description: Type of the WebAppAcceleration, as example LOAD_BALANCER. enum: - LOAD_BALANCER type: string x-obmcs-top-level-enum: '#/definitions/BackendType' compartmentId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAcceleration display name, can be renamed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object webAppAccelerationPolicyId: description: The [OCID](/Content/General/Concepts/identifiers.htm) of WebAppAccelerationPolicy, which is attached to the resource. maxLength: 255 minLength: 1 type: string required: - backendType - compartmentId - webAppAccelerationPolicyId type: object PurgeWebAppAccelerationCacheDetails: description: Specifies options for a cache purge. discriminator: propertyName: purgeType properties: purgeType: description: Type of cache purge to perform. enum: - ENTIRE_CACHE type: string required: - purgeType type: object GzipCompressionPolicy: description: 'An object that specifies the gzip compression policy. ' properties: isEnabled: default: false description: 'When true, support for gzip compression is enabled. HTTP responses will be compressed with gzip only if the client indicates support for gzip via the "Accept-Encoding: gzip" request header. When false, support for gzip compression is disabled and HTTP responses will not be compressed with gzip even if the client indicates support for gzip. ' type: boolean type: object ChangeWebAppAccelerationCompartmentDetails: description: Updates compartmentId of resource. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateWebAppAccelerationDetails: description: The information to be updated for WebAppAcceleration. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object displayName: description: WebAppAcceleration display name, can be renamed. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object webAppAccelerationPolicyId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of WebAppAccelerationPolicy, which is attached to the resource. This update guarantees that the resource always has WebAppAccelerationPolicy attached at any time. ' maxLength: 255 minLength: 1 type: string type: object WebAppAccelerationCollection: description: Result of a WebAppAcceleration list operation. properties: items: description: List of WebAppAccelerations. items: $ref: '#/components/schemas/WebAppAccelerationSummary' type: array required: - items type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: content-location: description: 'Content Location of the resource. ' format: uri-reference type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: 'Location of the resource. ' format: uri-reference type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string type is supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-oracle-package: com.oracle.oci.waf.controlplane