Aerospike REST Client

REST Interface for Aerospike Database.
More information: https://www.aerospike.com
Contact Info: hello@helloreverb.com
Version: 1.0
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

AdminOperations

BatchReadOperations

ClusterInformationOperations

InfoOperations

KeyValueOperations

OperateOperations

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

password string (required)
Body Parameter — password

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

rcRole RestClientRole (required)
Body Parameter — rcRole

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

userInfo RestClientUserModel (required)
Body Parameter — userInfo

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.

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

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.

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)

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

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)

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

privileges Privilege (required)
Body Parameter — privileges

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

roles string (required)
Body Parameter — roles

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

privileges Privilege (required)
Body Parameter — privileges

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

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

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

batchKeys BatchReadRequest (required)
Body Parameter — batchKeys

Query parameters

replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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)

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

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

infoRequests 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.

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

infoRequests 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.

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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.

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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.

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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.

Query parameters

bins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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.

Query parameters

bins (optional)
Query Parameter — Optionally specify a set of bins to return when fetching a record. If omitted, all bins will be returned.
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
replica (optional)
Query Parameter — Replica algorithm used to determine the target node for a single record command. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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.

Consumes

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

Query parameters

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

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.

Consumes

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

Query parameters

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

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

bins 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}}

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

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

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

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

Query parameters

commitLevel (optional)
Query Parameter — Desired consistency guarantee when committing a transaction on the server. default: COMMIT_ALL
durableDelete (optional)
Query Parameter — If the transaction results in a record deletion, leave a tombstone for the record. default: false
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
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. default: NONE
keytype (optional)
Query Parameter — The Type of the userKey. default: STRING
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. default: ONE
readModeSC (optional)
Query Parameter — Read policy for SC (strong consistency) namespaces. Determines SC read consistency options. default: SESSION
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. default: SEQUENCE
sendKey (optional)
Query Parameter — Send user defined key in addition to hash digest on both reads and writes. default: false

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

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

indexModel RestClientIndex (required)
Body Parameter — indexModel

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

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

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)

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.

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

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. Privilege - Privilege
  8. Record - Record
  9. RestClientError - RestClientError
  10. RestClientIndex - RestClientIndex
  11. RestClientRole - RestClientRole
  12. RestClientSetInformation - RestClientSetInformation
  13. RestClientUserModel - RestClientUserModel
  14. User - User
  15. clusterInformation - clusterInformation

BatchRead - BatchRead Up

binNames (optional)
array[String] List of bins to limit the record response to.
key (optional)
Key Key to retrieve a record
readAllBins (optional)
Boolean Whether all bins should be returned with this record
record (optional)
Record Record associated with the key. Null if the record was not found

BatchReadRequest - BatchReadRequest Up

binNames (optional)
array[String] List of bins to limit the record response to.
key
Key Key to retrieve a record
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.
keytype (optional)
String Enum describing the type of the userKey. This field is omitted in MessagePack responses.
Enum:
STRING
INTEGER
BYTES
DIGEST
namespace
String
setName (optional)
String
userKey (optional)
Object The user key, it may be a string, integer, or URL safe Base64 encoded bytes.

NamespaceInformation - NamespaceInformation Up

name (optional)
String
sets (optional)
array[RestClientSetInformation]

NodeInformation - NodeInformation Up

name (optional)
String

Operation - Operation Up

opValues
Object
operation
String

Privilege - Privilege Up

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

Record - Record Up

bins (optional)
Object A mapping from binName to binValue
generation (optional)
Integer The generation of the record. format: int32
ttl (optional)
Integer The time to live for the record, in seconds from now. format: int32

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.
internalErrorCode (optional)
Integer An internal error code for diagnostic purposes. This may be null format: int32
message (optional)
String A message describing the cause of the error.

RestClientIndex - RestClientIndex Up

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

RestClientRole - RestClientRole Up

name (optional)
String
privileges (optional)
array[Privilege]

RestClientSetInformation - RestClientSetInformation Up

name (optional)
String
objectCount (optional)
Integer format: int32

RestClientUserModel - RestClientUserModel Up

password (optional)
String
roles (optional)
array[String]
username (optional)
String

User - User Up

name (optional)
String
roles (optional)
array[String]

clusterInformation - clusterInformation Up

namespaces (optional)
array[NamespaceInformation]
nodes (optional)
array[NodeInformation]