Invalidate response cache

POST /apim/invalidate_response_cache

Overview

This API invalidates the response cache for APIs. The HTTP Response Cache policy caches the response data according to its specific settings and configuration. To ensure only valid and accurate data is cached, the API administrator can use this API to invalidate unneeded cached data.

Note:

You can manually or forcefully remove the cached data.
The cache invalidation mechanism monitors changes in the data source and updates the cache accordingly, ensuring consistency.

Prerequisites

Environment (Org) admin permissions

Request

 POST https://{controlplane_path}/api/1/rest/public/apim/invalidate_response_cache

Path Parameters


Key	Description
`controlplane_path`	Required. The path to the SnapLogic Control Plane: `elastic.snaplogic.com` For the UAT or EMEA control plane, substitute the name for `elastic`. For example: `uat.snaplogic.com` `emea.snaplogic.com`

Query Parameters

None.

Request Header

Specify Basic for authorization and application/json for content type.


Authorization: Basic {your_encoded_security_credentials}
Content-Type: application/json

Request Body


{
    "asset_path": "orgname/apim/proxypath",
    "plex_path": "/orgname/shared/snaplexname"
}


Key	Type	Description
`asset_path`	string	Path to the assets in an API version or API proxy.
`plex_path`	string	Path to the Snaplex. Note: Use single Snaplex configuration to make the API call as this API cannot be used for multiple Snaplex paths.

Note: The path is case-sensitive.

Response

Response Body


{
  "response_map": {
    "status": {
      "/orgname/shared/snaplexname": {
        "invalidated": true
      }
    },
    "asset_path": "orgname/apim/proxypath"
  },
  "http_status_code": 200
}


Key	Type	Description
`/orgname/shared/snaplexname`	string	The Snaplex path.
`invalidated`	boolean	If the value is true, then the cache data is invalidated. If the value is false, the cache is not invalidated.
`asset_path`	string	The path to the asset.

Error Handling


{
    "http_status_code": 404,
    "response_map": {
        "error_list": [
            {
                "message": "Could not find the specified plex path: /orgname/shared/snaplexname"
            }
        ]
    }
}


HTTP Status Codes	Message	Resolution
`404`	`{ "message": "Could not find the specified plex path: /Org1/shared/Cloud" }`	Check if you have entered a valid Snaplex. Check if the Snaplex is placed in global shared folder.