1. Infinispan REST API
team@openapitools.org 16.2.0-SNAPSHOT :toc: left :numbered: :toclevels: 4 :source-highlighter: highlightjs :keywords: openapi, rest, Infinispan REST API :specDir: :snippetDir: :generator-template: v1 2019-12-20 :info-url: https://openapi-generator.tech :app-name: Infinispan REST API
Infinispan OpenAPI descriptor
1.1. Endpoints
1.1.1. Cache
addSourceConnection
POST /rest/v3/caches/{cacheName}/rolling-upgrade/source-connection
Adds a source cluster connection for cache data migration
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The remote store configuration [object] |
X |
assignCacheAlias
POST /rest/v3/caches/{cacheName}/_assign-alias
-
cacheExists
HEAD /rest/v3/caches/{cacheName}
Determines if a cache exists
clearCache
POST /rest/v3/caches/{cacheName}/_clear
Clears a cache
convertCacheConfig
POST /rest/v3/_cache-config-convert
Convert cache configurations between formats
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
Cache configuration [string] |
X |
deleteByQuery
POST /rest/v3/caches/{cacheName}/_delete-by-query
Delete entries from a cache matching an Ickle query
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
JsonQueryRequest |
The query request object JsonQueryRequest |
X |
deleteByQueryDelete
DELETE /rest/v3/caches/{cacheName}/_delete-by-query
Delete entries from a cache matching an Ickle query (DELETE)
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
JsonQueryRequest |
The query request object JsonQueryRequest |
X |
deleteCache
DELETE /rest/v3/caches/{cacheName}
Deletes a cache
deleteCacheEntry
DELETE /rest/v3/caches/{cacheName}/entries/{cacheKey}
Delete an entry from a cache
disableCacheRebalancing
POST /rest/v3/caches/{cacheName}/_rebalancing-disable
Disable rebalancing for a cache
enableCacheRebalancing
POST /rest/v3/caches/{cacheName}/_rebalancing-enable
Enable rebalancing for a cache
getAllCacheAttributes
GET /rest/v3/caches/{cacheName}/config/attributes
Retrieve all mutable configuration attributes for a cache
getAllCacheEntries
GET /rest/v3/caches/{cacheName}/entries
Retrieve all entries from a cache
getAllCacheKeys
GET /rest/v3/caches/{cacheName}/keys
Retrieve all keys from a cache
Responses
| Code | Message | Datatype |
|---|---|---|
404 |
Cache not found |
|
200 |
All cache keys |
List[[string]] |
getCacheAttribute
GET /rest/v3/caches/{cacheName}/config/attributes/{attribute}
Retrieve the value of a single mutable configuration attribute for a cache
getCacheAvailability
GET /rest/v3/caches/{cacheName}/_availability
Retrieves the cache availability
getCacheConfig
GET /rest/v3/caches/{cacheName}/config
Retrieve cache configuration
getCacheDetails
GET /rest/v3/caches/{cacheName}/details
Retrieves details about a cache
getCacheDistribution
GET /rest/v3/caches/{cacheName}/_distribution
-
getCacheEntry
GET /rest/v3/caches/{cacheName}/entries/{cacheKey}
Retrieve an entry from a cache
Parameters
getCacheEvents
GET /rest/v3/caches/{cacheName}/_listen
Receive events from a cache
getCacheHealth
GET /rest/v3/caches/{cacheName}/_health
Retrieve the cache health
getCacheList
GET /rest/v3/caches
List available caches
Responses
| Code | Message | Datatype |
|---|---|---|
200 |
Cache list as a JSON array |
List[[string]] |
getCacheSize
GET /rest/v3/caches/{cacheName}/_size
Retrieves the number of entries in the cache
getCacheStats
GET /rest/v3/caches/{cacheName}/_stats
Retrieve cache statistics
getDetailedCacheList
GET /rest/v3/meta/caches/_detailed
List available caches with details
getKeyDistribution
GET /rest/v3/caches/{cacheName}/_distribution/{cacheKey}
Retrieve key distribution
getRoleAccessibleCaches
GET /rest/v3/meta/caches/_role-accessible
List caches accessible by a specific role
getSourceConnection
GET /rest/v3/caches/{cacheName}/rolling-upgrade/source-connection
Retrieves a source cluster connection for a cache
headCacheConfig
HEAD /rest/v3/caches/{cacheName}/config
Retrieve cache configuration
headCacheEntry
HEAD /rest/v3/caches/{cacheName}/entries/{cacheKey}
Retrieve an entry from a cache
Parameters
initializeCache
POST /rest/v3/caches/{cacheName}/_initialize
Initialize cache
postCache
POST /rest/v3/caches/{cacheName}
Creates a cache or updates its configuration
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The cache configuration [object] |
X |
postCacheAttribute
POST /rest/v3/caches/{cacheName}/config/attributes/{attribute}
Sets the value of a single mutable configuration attribute for a cache
postCacheAvailability
POST /rest/v3/caches/{cacheName}/_availability
Sets the cache availability
postCacheEntry
POST /rest/v3/caches/{cacheName}/entries/{cacheKey}
Put/update an entry in a cache
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
cacheName |
cacheName |
X |
null |
|
cacheKey |
cacheKey |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
Entry value [object] |
X |
postQueryCache
POST /rest/v3/caches/{cacheName}/_search
Performs an Ickle query on a cache
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
JsonQueryRequest |
The query request object JsonQueryRequest |
X |
putCache
PUT /rest/v3/caches/{cacheName}
Creates a cache or updates its configuration
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
The cache configuration [object] |
X |
putCacheEntry
PUT /rest/v3/caches/{cacheName}/entries/{cacheKey}
Put/update an entry in a cache
Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
cacheName |
cacheName |
X |
null |
|
cacheKey |
cacheKey |
X |
null |
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
body |
Entry value [object] |
X |
queryCache
GET /rest/v3/caches/{cacheName}/_search
Performs an Ickle query on a cache
removeSourceConnection
DELETE /rest/v3/caches/{cacheName}/rolling-upgrade/source-connection
Deletes a source cluster connection for cache data migration
resetCacheStats
POST /rest/v3/caches/{cacheName}/_stats-reset
Reset cache statistics
sourceConnectionExists
HEAD /rest/v3/caches/{cacheName}/rolling-upgrade/source-connection
Checks whether a source cluster connection exists for a cache