Aerospike REST Client

REST Interface for Aerospike Database.
More information: https://www.aerospike.com
Version: 1.7.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AdminOperations

BatchReadOperations

ClusterInformationOperations

ExecuteOperations

InfoOperations

KeyValueOperations

OperateOperations

ScanOperations

SecondaryIndexMethods

TruncateOperations

AdminOperations

Up
patch /v1/admin/user/{user}
Change the password of the specified user. (changePassword)

Path parameters

user (required)
Path Parameter — user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — password

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

403

Not authorized to modify users. RestClientError

404

Specified user not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/admin/role
Create a role on the Aerospike cluster. (createRole)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RestClientRole (required)
Body Parameter — rcRole

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid role creation parameters RestClientError

403

Not authorized to create roles. RestClientError

409

Role already exists. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/admin/user
Create a new user. (createUser)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RestClientUserModel (required)
Body Parameter — userInfo

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid user creation parameters RestClientError

403

Not authorized to create users. RestClientError

409

User already exists. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/admin/role/{name}
Remove a specific role from the Aerospike cluster. (dropRole)

Path parameters

name (required)
Path Parameter — The name of the role to remove.

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

403

Not authorized to remove roles RestClientError

404

Specified role not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/admin/user/{user}
Remove a user. (dropUser)

Path parameters

user (required)
Path Parameter — user

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

403

Not authorized to delete users. RestClientError

404

Specified user not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/admin/role/{name}
Get information about a specific role. (getRole)

Path parameters

name (required)
Path Parameter — The name of the role whose information should be retrieved.

Request headers

Return type

RestClientRole

Example data

Content-Type: application/json
{
  "privileges" : [ {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  }, {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  } ],
  "name" : "customRole"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientRole

403

Not authorized to read role information RestClientError

404

Specified role not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/admin/role
Return a list of all roles registered with the Aerospike cluster. (getRoles)

Request headers

Return type

array[RestClientRole]

Example data

Content-Type: application/json
[ {
  "privileges" : [ {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  }, {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  } ],
  "name" : "customRole"
}, {
  "privileges" : [ {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  }, {
    "code" : "user-admin",
    "set" : "testSet",
    "namespace" : "testNS"
  } ],
  "name" : "customRole"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Not authorized to read role information RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/admin/user/{user}
Return information about a specific user. (getUser)

Path parameters

user (required)
Path Parameter — user

Request headers

Return type

User

Example data

Content-Type: application/json
{
  "roles" : [ "roles", "roles" ],
  "name" : "name"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK User

403

Not authorized to read user information RestClientError

404

Specified user not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/admin/user
Return a list of information about users. (getUsers)

Request headers

Return type

array[User]

Example data

Content-Type: application/json
[ {
  "roles" : [ "roles", "roles" ],
  "name" : "name"
}, {
  "roles" : [ "roles", "roles" ],
  "name" : "name"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Not authorized to read user information RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/admin/role/{name}/privilege
Grant a list of privileges to a specific role. (grantPrivileges)

Path parameters

name (required)
Path Parameter — The name of the role to which privileges will be granted.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Privilege (required)
Body Parameter — privileges

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid privilege parameters RestClientError

403

Not authorized to modfiy roles. RestClientError

404

Specified role not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/admin/user/{user}/role
Grant a set of roles to the specified user. (grantRoles)

Path parameters

user (required)
Path Parameter — user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — roles

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid role parameters RestClientError

403

Not authorized to modify users. RestClientError

404

Specified user not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
patch /v1/admin/role/{name}/privilege/delete
Remove a list of privileges from a specific role. (revokePrivileges)

Path parameters

name (required)
Path Parameter — The name of the role from which privileges will be removed.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Privilege (required)
Body Parameter — privileges

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid privilege parameters RestClientError

403

Not authorized to modfiy roles. RestClientError

404

Specified role not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
patch /v1/admin/user/{user}/role/delete
Revoke a set of roles from the specified user. (revokeRoles)

Path parameters

user (required)
Path Parameter — The user from which to revoke roles

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — A list of names to revoke from the user

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid role parameters RestClientError

403

Not authorized to modify users. RestClientError

404

Specified user not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

BatchReadOperations

Up
post /v1/batch
Return multiple records from the server in a single request. (performBatchGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body BatchReadRequest (required)
Body Parameter — batchKeys

Request headers

Query parameters

allowInline (optional)
Query Parameter — Allow batch to be processed immediately in the server's receiving thread when the server deems it to be appropriate. If false, the batch will always be processed in separate transaction threads. This field is only relevant for the new batch index protocol.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
keytype (optional)
Query Parameter — The Type of the userKey.
maxConcurrentThreads (optional)
Query Parameter — Maximum number of concurrent synchronous batch request threads to server nodes at any point in time. If there are 16 node/namespace combinations requested and maxConcurrentThreads is 8, then batch requests will be made for 8 node/namespace combinations in parallel threads. When a request completes, a new request will be issued until all 16 requests are complete. format: int32
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sendSetName (optional)
Query Parameter — Send set name field to server for every key in the batch for batch index protocol. This is only necessary when authentication is enabled and security roles are defined on a per set basis.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

array[BatchRead]

Example data

Content-Type: application/json
[ {
  "readAllBins" : true,
  "record" : {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  },
  "binNames" : [ "binNames", "binNames" ],
  "key" : {
    "setName" : "testSet",
    "digest" : "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "namespace" : "testNS",
    "keytype" : "STRING",
    "userKey" : "userKey"
  }
}, {
  "readAllBins" : true,
  "record" : {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  },
  "binNames" : [ "binNames", "binNames" ],
  "key" : {
    "setName" : "testSet",
    "digest" : "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "namespace" : "testNS",
    "keytype" : "STRING",
    "userKey" : "userKey"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Non existent namespace used in one or more key. RestClientError

500

The REST Client encountered an error processing the request RestClientError

ClusterInformationOperations

Up
get /v1/cluster
Return an object containing information about the Aerospike cluster. (getClusterInfo)

Request headers

Return type

clusterInformation

Example data

Content-Type: application/json
{
  "nodes" : [ {
    "name" : "BB9DE9B1B270008"
  }, {
    "name" : "BB9DE9B1B270008"
  } ],
  "namespaces" : [ {
    "sets" : [ {
      "objectCount" : 100,
      "name" : "demo"
    }, {
      "objectCount" : 100,
      "name" : "demo"
    } ],
    "name" : "testNS"
  }, {
    "sets" : [ {
      "objectCount" : 100,
      "name" : "demo"
    }, {
      "objectCount" : 100,
      "name" : "demo"
    } ],
    "name" : "testNS"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK clusterInformation

500

The REST Client encountered an error processing the request RestClientError

ExecuteOperations

Up
post /v1/execute/scan/{namespace}
Perform multiple operations in background scan/query. (executeScanNamespace)

Path parameters

namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Operation (required)
Body Parameter — An array of operation objects specifying the operations to perform on the record.

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

RestClientExecuteTask

Example data

Content-Type: application/json
{
  "scan" : true,
  "taskId" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientExecuteTask

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace does not exist RestClientError

409

Generation conflict RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/execute/scan/{namespace}/{set}
Perform multiple operations in background scan/query. (executeScanNamespaceSet)

Path parameters

namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Operation (required)
Body Parameter — An array of operation objects specifying the operations to perform on the record.

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

RestClientExecuteTask

Example data

Content-Type: application/json
{
  "scan" : true,
  "taskId" : 0
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientExecuteTask

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace or set does not exist RestClientError

409

Generation conflict RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/execute/scan/status/{taskId}
Get status of background scan by task id. (executeScanStatus)

Path parameters

taskId (required)
Path Parameter — Background scan task id.

Request headers

Return type

RestClientExecuteTaskStatus

Example data

Content-Type: application/json
{
  "task" : {
    "scan" : true,
    "taskId" : 0
  },
  "status" : "status"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientExecuteTaskStatus

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

500

The REST Client encountered an error processing the request RestClientError

InfoOperations

Up
post /v1/info
Send a list of info commands to a random node in the cluster (infoAny)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — An array of info commands to send to the server. See https://www.aerospike.com/docs/reference/info/ for a list of valid commands.

Request headers

Return type

map[String, String]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Commands sent succesfully.

403

Not authorized to perform the info command RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/info/{node}
Send a list of info commands to a specific node in the cluster. (infoNode)

Path parameters

node (required)
Path Parameter — The node ID for the node which will receive the info commands.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body string (required)
Body Parameter — An array of info commands to send to the server. See https://www.aerospike.com/docs/reference/info/ for a list of valid commands.

Request headers

Return type

map[String, String]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Commands sent succesfully.

403

Not authorized to perform the info command RestClientError

404

The specified Node does not exist. RestClientError

500

The REST Client encountered an error processing the request RestClientError

KeyValueOperations

Up
post /v1/kvs/{namespace}/{key}
Create a new record with the provided bins into the record. (createRecordNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace does not exist RestClientError

409

Record Already exists RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/kvs/{namespace}/{set}/{key}
Create a new record with the provided bins into the record. (createRecordNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace does not exist RestClientError

409

Record Already exists RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/kvs/{namespace}/{key}
Delete the specified record. (deleteRecordNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record not found. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/kvs/{namespace}/{set}/{key}
Delete the specified record. (deleteRecordNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record not found. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/kvs/{namespace}/{key}
Return the metadata and bins for a record. (getRecordNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Request headers

Query parameters

compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

Record

Example data

Content-Type: application/json
{
  "generation" : 2,
  "bins" : {
    "bin1" : "val1",
    "pi" : "3.14"
  },
  "ttl" : 1000
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Record

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record not found. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/kvs/{namespace}/{set}/{key}
Return the metadata and bins for a record. (getRecordNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Request headers

Query parameters

compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

Record

Example data

Content-Type: application/json
{
  "generation" : 2,
  "bins" : {
    "bin1" : "val1",
    "pi" : "3.14"
  },
  "ttl" : 1000
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Record

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record not found. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
head /v1/kvs/{namespace}/{key}
Check if a record exists (recordExistsNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Request headers

Query parameters

keytype (optional)
Query Parameter — The Type of the userKey.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

404

Record does not exist.

500

The REST Client encountered an error processing the request RestClientError

Up
head /v1/kvs/{namespace}/{set}/{key}
Check if a record exists (recordExistsNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Request headers

Query parameters

keytype (optional)
Query Parameter — The Type of the userKey.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

404

Record does not exist.

500

The REST Client encountered an error processing the request RestClientError

Up
put /v1/kvs/{namespace}/{key}
Replace the bins of the specified record. (replaceRecordNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record does not exist. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
put /v1/kvs/{namespace}/{set}/{key}
Replace the bins of the specified record. (replaceRecordNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record does not exist. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
patch /v1/kvs/{namespace}/{key}
Merge the provided bins into the record. (updateRecordNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record does not exist. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
patch /v1/kvs/{namespace}/{set}/{key}
Merge the provided bins into the record. (updateRecordNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body object (required)
Body Parameter — Bins to be stored in the record. This is a mapping from a string bin name to a value. Value can be a String, integer, floating point number, list, map, bytearray, or GeoJSON value. Bytearrays and GeoJSON can only be sent using MessagePack example: {"bin1":5, "bin2":"hello", "bin3": [1,2,3], "bin4": {"one": 1}}

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

No Content

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Record does not exist. RestClientError

409

Generation mismatch for operation RestClientError

500

The REST Client encountered an error processing the request RestClientError

OperateOperations

Up
post /v1/operate/{namespace}/{key}
Perform multiple operations atomically on the specified record. (operateNamespaceKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Operation (required)
Body Parameter — An array of operation objects specifying the operations to perform on the record

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

Record

Example data

Content-Type: application/json
{
  "generation" : 2,
  "bins" : {
    "bin1" : "val1",
    "pi" : "3.14"
  },
  "ttl" : 1000
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Record

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace or record does not exist RestClientError

409

Generation conflict RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
post /v1/operate/{namespace}/{set}/{key}
Perform multiple operations atomically on the specified record. (operateNamespaceSetKey)

Path parameters

key (required)
Path Parameter — Userkey for the record.
namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Operation (required)
Body Parameter — An array of operation objects specifying the operations to perform on the record

Request headers

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server.
compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record.
expiration (optional)
Query Parameter — Record expiration. Also known as ttl (time to live). Seconds record will live before being removed by the server. format: int32
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
generation (optional)
Query Parameter — Expected generation. Generation is the number of times a record has been modified (including creation) on the server. format: int32
generationPolicy (optional)
Query Parameter — Qualify how to handle record writes based on record generation.
keytype (optional)
Query Parameter — The Type of the userKey.
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordExistsAction (optional)
Query Parameter — How to handle the existence of the record. This is ignored for POST/PUT/UPDATE kvs methods.
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
respondAllOps (optional)
Query Parameter — For client operate(), return a result for every operation.
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

Record

Example data

Content-Type: application/json
{
  "generation" : 2,
  "bins" : {
    "bin1" : "val1",
    "pi" : "3.14"
  },
  "ttl" : 1000
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK Record

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace or record does not exist RestClientError

409

Generation conflict RestClientError

500

The REST Client encountered an error processing the request RestClientError

ScanOperations

Up
get /v1/scan/{namespace}/{set}
Return multiple records from the server in a scan request. (performScan)

Path parameters

namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.
set (required)
Path Parameter — Set for the record; equivalent to database table.

Request headers

Query parameters

compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
concurrentNodes (optional)
Query Parameter — Should scan requests be issued in parallel.
failOnClusterChange (optional)
Query Parameter — Terminate scan if cluster in migration state. Only used for server versions < 4.9.
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
from (optional)
Query Parameter — Next page token parameter.
includeBinData (optional)
Query Parameter — Should bin data be retrieved. If false, only record digests (and user keys if stored on the server) are retrieved.
keytype (optional)
Query Parameter — The Type of the userKey.
maxConcurrentNodes (optional)
Query Parameter — Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then scan requests will be made to 8 nodes in parallel. When a scan completes, a new scan request will be issued until all 16 nodes have been scanned. This field is only relevant when concurrentNodes is true. format: int32
maxRecords (optional)
Query Parameter — Number of records to return. format: int32
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordsPerSecond (optional)
Query Parameter — Limit returned records per second (rps) rate for each server. Do not apply rps limit if recordsPerSecond is zero. format: int32
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
scanPercent (optional)
Query Parameter — Percent of data to scan. Valid integer range is 1 to 100. This field is supported on server versions < 4.9. For server versions >= 4.9, use maxRecords. format: int32
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

RestClientScanResponse

Example data

Content-Type: application/json
{
  "pagination" : {
    "totalRecords" : 0,
    "nextToken" : "nextToken"
  },
  "records" : [ {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  }, {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientScanResponse

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace or set does not exist RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/scan/{namespace}
Return multiple records from the server in a scan request. (performScan1)

Path parameters

namespace (required)
Path Parameter — Namespace for the record; equivalent to database name.

Request headers

Query parameters

compress (optional)
Query Parameter — Use zlib compression on command buffers sent to the server and responses received from the server when the buffer size is greater than 128 bytes.
concurrentNodes (optional)
Query Parameter — Should scan requests be issued in parallel.
failOnClusterChange (optional)
Query Parameter — Terminate scan if cluster in migration state. Only used for server versions < 4.9.
filterexp (optional)
Query Parameter — Optional Filter Expression (introduced in Aerospike Database 5.2.0) in infix notation DSL.
from (optional)
Query Parameter — Next page token parameter.
includeBinData (optional)
Query Parameter — Should bin data be retrieved. If false, only record digests (and user keys if stored on the server) are retrieved.
keytype (optional)
Query Parameter — The Type of the userKey.
maxConcurrentNodes (optional)
Query Parameter — Maximum number of concurrent requests to server nodes at any point in time. If there are 16 nodes in the cluster and maxConcurrentNodes is 8, then scan requests will be made to 8 nodes in parallel. When a scan completes, a new scan request will be issued until all 16 nodes have been scanned. This field is only relevant when concurrentNodes is true. format: int32
maxRecords (optional)
Query Parameter — Number of records to return. format: int32
maxRetries (optional)
Query Parameter — Maximum number of retries before aborting the current transaction. The initial attempt is not counted as a retry. format: int32
predexp (optional)
Query Parameter — Optional Predicate Expression filter (obsolete as of Aerospike Database 5.2.0) in infix notation DSL. If the Predicate Expression exists and evaluates to false, the transaction is ignored.
readModeAP (optional)
Query Parameter — Read policy for AP (availability) namespaces. How duplicates should be consulted in a read operation. Only makes a difference during migrations and only applicable in AP mode.
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options.
recordBins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
recordsPerSecond (optional)
Query Parameter — Limit returned records per second (rps) rate for each server. Do not apply rps limit if recordsPerSecond is zero. format: int32
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command.
scanPercent (optional)
Query Parameter — Percent of data to scan. Valid integer range is 1 to 100. This field is supported on server versions < 4.9. For server versions >= 4.9, use maxRecords. format: int32
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes.
sleepBetweenRetries (optional)
Query Parameter — Milliseconds to sleep between retries. format: int32
socketTimeout (optional)
Query Parameter — Socket idle timeout in milliseconds when processing a database command. format: int32
totalTimeout (optional)
Query Parameter — Total transaction timeout in milliseconds. format: int32

Return type

RestClientScanResponse

Example data

Content-Type: application/json
{
  "pagination" : {
    "totalRecords" : 0,
    "nextToken" : "nextToken"
  },
  "records" : [ {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  }, {
    "generation" : 2,
    "bins" : {
      "bin1" : "val1",
      "pi" : "3.14"
    },
    "ttl" : 1000
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK RestClientScanResponse

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

404

Namespace does not exist RestClientError

500

The REST Client encountered an error processing the request RestClientError

SecondaryIndexMethods

Up
post /v1/index
Create a secondary index. (createIndex)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body RestClientIndex (required)
Body Parameter — indexModel

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid index creation parameters. RestClientError

403

Not authorized to access the resource. RestClientError

409

Index with the same name already exists, or equivalent index exists. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/index/{namespace}/{name}
Remove a secondary Index (dropIndex)

Path parameters

name (required)
Path Parameter — The name of the index
namespace (required)
Path Parameter — The namespace containing the index

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

403

Not authorized to access the resource. RestClientError

404

Specified Index does not exist. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/index/{namespace}/{name}
Get Information about a single secondary index. (getIndexStats)

Path parameters

name (required)
Path Parameter — The name of the index
namespace (required)
Path Parameter — The namespace containing the index

Request headers

Return type

map[String, String]

Example data

Content-Type: application/json
{
  "key" : ""
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Not authorized to access the resource. RestClientError

404

Specified Index does not exist. RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
get /v1/index
Return information about multiple secondary indices. (indexInformation)

Request headers

Query parameters

namespace (optional)
Query Parameter — If specified, the list of returned indices will only contain entries from this namespace.

Return type

array[RestClientIndex]

Example data

Content-Type: application/json
[ {
  "set" : "testSet",
  "bin" : "ageBin",
  "name" : "ageIndex",
  "namespace" : "testNS",
  "type" : "NUMERIC",
  "collection_type" : "DEFAULT"
}, {
  "set" : "testSet",
  "bin" : "ageBin",
  "name" : "ageIndex",
  "namespace" : "testNS",
  "type" : "NUMERIC",
  "collection_type" : "DEFAULT"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK

403

Not authorized to access the resource. RestClientError

404

Specified namespace not found RestClientError

500

The REST Client encountered an error processing the request RestClientError

TruncateOperations

Up
delete /v1/truncate/{namespace}
Truncate records in a specified namespace. (truncateNamespace)

Path parameters

namespace (required)
Path Parameter — The namespace whose records will be truncated.

Request headers

Query parameters

date (optional)
Query Parameter — All records last updated before this date/time will be truncated. If not specified, all records will be truncated. This is a string representation of a date time utilizing the ISO-8601 extended offset date-time format. example: 2019-12-03T10:15:30+01:00

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

500

The REST Client encountered an error processing the request RestClientError

Up
delete /v1/truncate/{namespace}/{set}
Truncate records in a specified namespace and set. (truncateSet)

Path parameters

namespace (required)
Path Parameter — The namespace whose records will be truncated
set (required)
Path Parameter — The set, in the specified namespace, whose records will be truncated

Request headers

Query parameters

date (optional)
Query Parameter — All records last updated before this date/time will be truncated. If not specified, all records will be truncated. This is a string representation of a date time utilizing the ISO-8601 extended offset date-time format. example: 2019-12-03T10:15:30+01:00

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

202

Accepted

400

Invalid parameters or request RestClientError

403

Not authorized to access the resource RestClientError

500

The REST Client encountered an error processing the request RestClientError

Models

[ Jump to Methods ]

Table of Contents

  1. BatchRead - BatchRead
  2. BatchReadRequest - BatchReadRequest
  3. Key - Key
  4. NamespaceInformation - NamespaceInformation
  5. NodeInformation - NodeInformation
  6. Operation - Operation
  7. Pagination - Pagination
  8. Privilege - Privilege
  9. Record - Record
  10. RestClientError - RestClientError
  11. RestClientExecuteTask - RestClientExecuteTask
  12. RestClientExecuteTaskStatus - RestClientExecuteTaskStatus
  13. RestClientIndex - RestClientIndex
  14. RestClientRole - RestClientRole
  15. RestClientScanResponse - RestClientScanResponse
  16. RestClientSetInformation - RestClientSetInformation
  17. RestClientUserModel - RestClientUserModel
  18. User - User
  19. clusterInformation - clusterInformation

BatchRead - BatchRead Up

binNames (optional)
array[String] List of bins to limit the record response to.
key (optional)
readAllBins (optional)
Boolean Whether all bins should be returned with this record
record (optional)

BatchReadRequest - BatchReadRequest Up

binNames (optional)
array[String] List of bins to limit the record response to.
key
readAllBins (optional)
Boolean Whether all bins should be returned with this record

Key - Key Up

digest (optional)
String URL safe base64 encoded key digest. Returned by the server on batch responses. May be provided by client.
example: AAAAAAAAAAAAAAAAAAAAAAAAAAA=
keytype (optional)
String Enum describing the type of the userKey. This field is omitted in MessagePack responses.
Enum:
STRING
INTEGER
BYTES
DIGEST
example: STRING
namespace
example: testNS
setName (optional)
example: testSet
userKey (optional)
Object The user key, it may be a string, integer, or URL safe Base64 encoded bytes.
example: userKey

NamespaceInformation - NamespaceInformation Up

name (optional)
example: testNS
sets (optional)

NodeInformation - NodeInformation Up

name (optional)
example: BB9DE9B1B270008

Operation - Operation Up

opValues
example: {"bin":"listbin","values":[1,2,3]}
operation
String Aerospike operation to perform on the record
Enum:
ADD
APPEND
GET
PREPEND
READ
GET_HEADER
TOUCH
PUT
DELETE
LIST_APPEND
LIST_APPEND_ITEMS
LIST_CLEAR
LIST_GET
LIST_GET_BY_INDEX
LIST_GET_BY_INDEX_RANGE
LIST_GET_BY_RANK
LIST_GET_BY_RANK_RANGE
LIST_GET_BY_VALUE_REL_RANK_RANGE
LIST_GET_BY_VALUE
LIST_GET_BY_VALUE_RANGE
LIST_GET_BY_VALUE_LIST
LIST_GET_RANGE
LIST_INCREMENT
LIST_INSERT
LIST_INSERT_ITEMS
LIST_POP
LIST_POP_RANGE
LIST_REMOVE
LIST_REMOVE_BY_INDEX
LIST_REMOVE_BY_INDEX_RANGE
LIST_REMOVE_BY_RANK
LIST_REMOVE_BY_RANK_RANGE
LIST_REMOVE_BY_VALUE_REL_RANK_RANGE
LIST_REMOVE_BY_VALUE
LIST_REMOVE_BY_VALUE_RANGE
LIST_REMOVE_BY_VALUE_LIST
LIST_REMOVE_RANGE
LIST_SET
LIST_SET_ORDER
LIST_SIZE
LIST_SORT
LIST_TRIM
LIST_CREATE
MAP_CLEAR
MAP_DECREMENT
MAP_GET_BY_INDEX
MAP_GET_BY_INDEX_RANGE
MAP_GET_BY_KEY
MAP_GET_BY_KEY_LIST
MAP_GET_BY_KEY_RANGE
MAP_GET_BY_RANK
MAP_GET_BY_RANK_RANGE
MAP_GET_BY_VALUE
MAP_GET_BY_VALUE_RANGE
MAP_GET_BY_VALUE_LIST
MAP_GET_BY_KEY_REL_INDEX_RANGE
MAP_GET_BY_VALUE_REL_RANK_RANGE
MAP_INCREMENT
MAP_PUT
MAP_PUT_ITEMS
MAP_REMOVE_BY_INDEX
MAP_REMOVE_BY_INDEX_RANGE
MAP_REMOVE_BY_KEY
MAP_REMOVE_BY_KEY_RANGE
MAP_REMOVE_BY_RANK
MAP_REMOVE_BY_RANK_RANGE
MAP_REMOVE_BY_KEY_REL_INDEX_RANGE
MAP_REMOVE_BY_VALUE_REL_RANK_RANGE
MAP_REMOVE_BY_VALUE
MAP_REMOVE_BY_VALUE_RANGE
MAP_REMOVE_BY_VALUE_LIST
MAP_SET_MAP_POLICY
MAP_SIZE
MAP_CREATE
BIT_RESIZE
BIT_INSERT
BIT_REMOVE
BIT_SET
BIT_OR
BIT_XOR
BIT_AND
BIT_NOT
BIT_LSHIFT
BIT_RSHIFT
BIT_ADD
BIT_SUBTRACT
BIT_SET_INT
BIT_GET
BIT_COUNT
BIT_LSCAN
BIT_RSCAN
BIT_GET_INT
HLL_INIT
HLL_ADD
HLL_SET_UNION
HLL_SET_COUNT
HLL_FOLD
HLL_COUNT
HLL_UNION
HLL_UNION_COUNT
HLL_INTERSECT_COUNT
HLL_SIMILARITY
HLL_DESCRIBE
example: LIST_APPEND_ITEMS

Pagination - Pagination Up

nextToken (optional)
String The next page token.
totalRecords (optional)
Long The total number of records in page. format: int64

Privilege - Privilege Up

code
Enum:
user-admin
sys-admin
data-admin
read
read-write
read-write-udf
write
namespace (optional)
String Namespace Scope
example: testNS
set (optional)
String setName Scope
example: testSet

Record - Record Up

bins (optional)
Object A mapping from binName to binValue
example: {"bin1":"val1","pi":"3.14"}
generation (optional)
Integer The generation of the record. format: int32
example: 2
ttl (optional)
Integer The time to live for the record, in seconds from now. format: int32
example: 1000

RestClientError - RestClientError Up

Error object returned from unsuccesful operations.
inDoubt (optional)
Boolean A boolean specifying whether it was possible that the operation succeeded. This is only included if true.
example: false
internalErrorCode (optional)
Integer An internal error code for diagnostic purposes. This may be null format: int32
example: -3
message (optional)
String A message describing the cause of the error.
example: Error Message

RestClientExecuteTask - RestClientExecuteTask Up

scan (optional)
Boolean The scan indicator.
taskId (optional)
Long The task ID value. format: int64

RestClientExecuteTaskStatus - RestClientExecuteTaskStatus Up

status (optional)
String The ExecuteTask status.
task (optional)

RestClientIndex - RestClientIndex Up

bin (optional)
String The bin which is indexed
example: ageBin
collection_type (optional)
Enum:
DEFAULT
LIST
MAPKEYS
MAPVALUES
name (optional)
String The name of the index. This must be unique per set
example: ageIndex
namespace (optional)
example: testNS
set (optional)
example: testSet
type (optional)
Enum:
NUMERIC
STRING
GEO2DSPHERE

RestClientRole - RestClientRole Up

name (optional)
example: customRole
privileges (optional)

RestClientScanResponse - RestClientScanResponse Up

pagination (optional)
records (optional)
array[Record] List of records for current page.

RestClientSetInformation - RestClientSetInformation Up

name (optional)
example: demo
objectCount (optional)
Integer format: int32
example: 100

RestClientUserModel - RestClientUserModel Up

password (optional)
roles (optional)
username (optional)

User - User Up

name (optional)
roles (optional)

clusterInformation - clusterInformation Up

namespaces (optional)
nodes (optional)