service.getCacheStatus

Description

Returns the content cache status for a given service.

Parameters

service key

A string representing the unique id of the service to return status on.  You may also pass a json object with a field of service_key to identify the service you wish to fetch.

Response

array|object — Object describing the service's content cache status. Cache expiry times are in minutes; 0 means the content cache is disabled for this service

Examples

A Sample JSON-RPC Get Cache Status Request

{
    "method": "service.getCacheStatus",
    "params": [
        "your_service_key_here"
    ],
    "id": 1 
}

The JSON-RPC Response

{
    "result": {
        "cache_expiry_times": [
            {
                "*": 1440 
            } 
        ],
        "cache_batch": 1 
    },
    "error": null,
    "id": 1 
}

Permissions Required

The user who owns the key used to authenticate the service.getCacheStatus call must be a member of one of the following roles

  • Administrator
  • Api Manager

See authentication.

Errors

In addition to the standard json-rpc errors and authentication errors, service.getCacheStatus may also return these errors:

HTTP Status Code JSON-RPC Code Error Message Description
400 1002 Field "id" is required You've passed an object to trigger the alternative object identifier syntax, but that object does not contain an id field.
400 5000 Object "type" with "key" of "value" could not be found The object could not be updated because it could not be found.

Docs Navigation