IOM Cache Management REST API (1.0)

Download OpenAPI specification:Download

Cache operations to manage application caches.

Authentication

basicAuth

Basic Authentication

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

Cache Management

Returns the statuses for all cache for all server nodes.

Authorizations:

basicAuth

Responses

200

The request has succeeded.

401

Unauthorized or Forbidden.

500

Internal server error.

get /caches

{protocol}://{domain}:{port}/servlets/services/caches/caches

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": 0,
"cacheName": "bakery-cache-config",
"clearDate": "2020-04-16T16:12:26Z",
"action": "server startup",
"serverId": "BACKEND_0.0.0.0"
}
],
"statusCode": 0,
"errors": 
[
{"message": "string",
"sourceField": "string"
}
],
"exceptions": 
[
{"message": "string",
"code": "string"
}
]
}

Returns the statuses of the given cache name for all server nodes.

Authorizations:

basicAuth

path Parameters

cacheName

required

string

Value: "bakery-cache-config"

Name of the cache the action should be processed for.

Responses

200

The request has succeeded.

401

Unauthorized or Forbidden.

500

Internal server error.

get /caches/{cacheName}

{protocol}://{domain}:{port}/servlets/services/caches/caches/{cacheName}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"data": 
[
{"id": 0,
"cacheName": "bakery-cache-config",
"clearDate": "2020-04-16T16:12:26Z",
"action": "server startup",
"serverId": "BACKEND_0.0.0.0"
}
],
"statusCode": 0,
"errors": 
[
{"message": "string",
"sourceField": "string"
}
],
"exceptions": 
[
{"message": "string",
"code": "string"
}
]
}

Requests to clear a given cache on all server nodes.

Requests to clear a given cache on all server nodes. The cache clear will be processed asynchronously from all server nodes.

Authorizations:

basicAuth

path Parameters

cacheName

required

string

Value: "bakery-cache-config"

Name of the cache the action should be processed for.

Responses

200

The request has succeeded.

401

Unauthorized or Forbidden

500

Internal server error.

delete /caches/{cacheName}

{protocol}://{domain}:{port}/servlets/services/caches/caches/{cacheName}