--- title: "Update an existing cluster" description: "Update an existing cluster." --- # Update an existing cluster > For the complete documentation index see: [llms.txt](https://aerospike.com/docs/llms.txt) > > All documentation pages available in markdown. PATCH /database/clusters/{clusterId} - Update an existing cluster. ## Authorizations - **[publicOauth2](https://aerospike.com/docs/cloud/reference/api/#publicoauth2)** update:database ## Parameters ### Path Parameters **clusterId** required string format: uuid A cluster ID. ## Request Body Update cluster request object **name** string Example: My cool cluster **logging** object **logBucket** The ARN of the S3 bucket the logs reside in string Example: arn:aws:s3:::db\_logs **authorizedRoles** A list of role ARNs authorized to read the log bucket Array Example: \[ "arn:aws:iam::123456789012:role/ASLogReader" \] **infrastructure** object **provider** Cloud provider for the infrastructure string Allowed values: aws gcp **instanceType** Instance type for vertical scaling string Example: m5d.large **region** AWS region where resources will be deployed string Example: us-east-1 **availabilityZoneCount** Number of availability zones to spread resources across integer \>= 1 <= 3 **zoneIds** AWS availability zone IDs for aerospike nodes Array Example: \[ "use1-az1" \] **cidrBlock** IPv4 CIDR block for the database VPC. GCP requires /16; AWS requires /19. string /^((25\[0-5\]|2\[0-4\]\[0-9\]|\[01\]?\[0-9\]\[0-9\]?)\\.){3}(25\[0-5\]|2\[0-4\]\[0-9\]|\[01\]?\[0-9\]\[0-9\]?)/(?:16|19)$/ Example: 10.128.0.0/19 **networkId** The network ID of the database string Example: vpc-01234567890123456 **accountId** The account ID of the database string Example: 123456789012 **networkAttachedStorage** One of: - [gp2](#tab-panel-204) - [gp3](#tab-panel-205) - [io1](#tab-panel-206) - [io2](#tab-panel-207) _gp2_ object **type** General Purpose SSD (gp2) string Allowed values: gp2 **sizeInGB** Size of the EBS volume in gigabytes integer \>= 1 _gp3_ object **type** General Purpose SSD (gp3) string Allowed values: gp3 **iops** IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema). integer \>= 3000 <= 16000 **sizeInGB** Size of the EBS volume in gigabytes integer \>= 1 _io1_ object **type** Provisioned IOPS SSD (io1) string Allowed values: io1 **iops** IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema). integer \>= 100 <= 64000 **sizeInGB** Size of the EBS volume in gigabytes (min 4 for io1) integer \>= 4 _io2_ object **type** Provisioned IOPS SSD (io2) string Allowed values: io2 **iops** IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema). integer \>= 100 <= 64000 **sizeInGB** Size of the EBS volume in gigabytes (min 4 for io2) integer \>= 4 **hostedZoneId** The Route 53 hosted zone ID for the database string Example: Z1234567890ABCD **aerospikeCloud** Any of: - [In-memory database](#tab-panel-217) - [Local disk database](#tab-panel-218) - [Network storage database](#tab-panel-219) object **clusterSize** Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** string Allowed values: memory local-disk network-storage **dataStorage** Allowed values: memory **dataResiliency** Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence. string Allowed values: local-disk network-storage object **clusterSize** Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** string Allowed values: memory local-disk network-storage **dataStorage** Allowed values: local-disk **dataResiliency** Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence. string Allowed values: network-storage object **clusterSize** Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** string Allowed values: memory local-disk network-storage **dataStorage** Allowed values: network-storage **aerospikeServer** Aerospike server configuration object **service** object **advertise-ipv6** boolean nullable **auto-pin** string nullable Allowed values: none cpu numa adq **batch-index-threads** integer nullable \>= 1 <= 256 **batch-max-buffers-per-queue** integer nullable <= 4294967295 **batch-max-requests** integer nullable <= 4294967295 **batch-max-unused-buffers** integer nullable <= 4294967295 **cluster-name** string **debug-allocations** boolean nullable **disable-udf-execution** boolean nullable **enable-benchmarks-fabric** boolean nullable **enable-health-check** boolean nullable **enable-hist-info** boolean nullable **enforce-best-practices** boolean **feature-key-file** string **feature-key-files** Array **group** string **indent-allocations** boolean nullable **info-max-ms** integer nullable \>= 500 <= 10000 **info-threads** integer nullable <= 2147483647 **keep-caps-ssd-health** boolean **log-local-time** boolean **log-millis** boolean **microsecond-histograms** boolean **migrate-fill-delay** integer <= 4294967295 **migrate-max-num-incoming** integer <= 256 **migrate-threads** integer <= 100 **min-cluster-size** integer <= 256 **node-id** string **node-id-interface** string **os-group-perms** boolean **pidfile** string **poison-allocations** boolean nullable **proto-fd-idle-ms** integer nullable <= 2147483647 **proto-fd-max** integer nullable <= 58982 **quarantine-allocations** integer nullable <= 100000000 **query-max-done** integer nullable <= 10000 **query-threads-limit** integer nullable \>= 1 <= 1024 **run-as-daemon** boolean **secrets-address-port** string **secrets-tls-context** string **secrets-uds-path** string **service-threads** integer nullable \>= 1 <= 4096 **sindex-builder-threads** integer nullable \>= 1 <= 32 **sindex-gc-period** integer nullable <= 4294967295 **stay-quiesced** boolean **ticker-interval** integer <= 4294967295 **tls-refresh-period** integer <= 4294967295 **transaction-max-ms** integer nullable <= 4294967295 **transaction-retry-ms** integer nullable <= 4294967295 **user** string **vault-ca** string **vault-namespace** string **vault-path** string **vault-token-file** string **vault-url** string **work-directory** string **logging** Array object **name** string default: \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **misc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **alloc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **arenax** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hardware** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **msg** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **os** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **secrets** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **socket** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **tls** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **vault** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **vmapx** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xmem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **aggr** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **appeal** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **as** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **audit** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **batch** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **batch-sub** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **bin** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **config** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **clustering** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **deprecation** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv-mem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv\_pmem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv\_ssd** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **exchange** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **exp** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **fabric** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **flat** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **geo** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hb** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **health** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hlc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **index** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **info** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **info-command** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **key-busy** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **migrate** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **mrt-audit** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **mrt-monitor** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **namespace** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **nsup** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **particle** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **partition** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proto** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proxy** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proxy-divert** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **query** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **record** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **roster** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **rw** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **rw-client** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **security** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **service** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **service-list** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **sindex** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **skew** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **smd** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **storage** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **truncate** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **tsvc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **udf** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xdr** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xdr-client** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **masking** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **any** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **facility** default: local0 Allowed values: auth authpriv cron daemon ftp kern lpr mail news syslog user uucp local0 local1 local2 local3 local4 local5 local6 local7 **path** string default: /dev/log \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **tag** string default: asd \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **network** object **service** Any of: - [object](#tab-panel-256) - [object](#tab-panel-257) object **access-addresses** Array default: nullable **access-port** integer nullable \>= 1024 <= 65535 **addresses** Array default: nullable **alternate-access-addresses** Array default: nullable **alternate-access-port** integer nullable \>= 1024 <= 65535 **disable-localhost** boolean nullable **port** integer nullable \>= 1024 <= 65535 **tls-access-addresses** Array default: nullable **tls-access-port** integer nullable \>= 1024 <= 65535 **tls-addresses** Array default: nullable **tls-alternate-access-addresses** Array default: nullable **tls-alternate-access-port** integer nullable \>= 1024 <= 65535 **tls-authenticate-client** One of: - [string](#tab-panel-186) - [Array](#tab-panel-187) string default: any Allowed values: any false Array **tls-name** string format: hostname nullable **tls-port** integer nullable \>= 1024 <= 65535 object **access-addresses** Array default: nullable **access-port** integer nullable \>= 1024 <= 65535 **addresses** Array default: nullable **alternate-access-addresses** Array default: nullable **alternate-access-port** integer nullable \>= 1024 <= 65535 **disable-localhost** boolean nullable **port** integer nullable \>= 1024 <= 65535 **tls-access-addresses** Array default: nullable **tls-access-port** integer nullable \>= 1024 <= 65535 **tls-addresses** Array default: nullable **tls-alternate-access-addresses** Array default: nullable **tls-alternate-access-port** integer nullable \>= 1024 <= 65535 **tls-authenticate-client** One of: - [string](#tab-panel-188) - [Array](#tab-panel-189) string default: any Allowed values: any false Array **tls-name** string format: hostname nullable **tls-port** integer nullable \>= 1024 <= 65535 **admin** Any of: - [object](#tab-panel-252) - [object](#tab-panel-253) object **addresses** Array default: nullable **disable-localhost** boolean nullable **port** integer nullable \>= 1024 <= 65535 **tls-addresses** Array default: nullable **tls-authenticate-client** One of: - [string](#tab-panel-190) - [Array](#tab-panel-191) string default: any Allowed values: any false Array **tls-name** string "" nullable **tls-port** integer nullable \>= 1024 <= 65535 object **addresses** Array default: nullable **disable-localhost** boolean nullable **port** integer nullable \>= 1024 <= 65535 **tls-addresses** Array default: nullable **tls-authenticate-client** One of: - [string](#tab-panel-192) - [Array](#tab-panel-193) string default: any Allowed values: any false Array **tls-name** string "" nullable **tls-port** integer nullable \>= 1024 <= 65535 **heartbeat** Any of: - [object](#tab-panel-222) - [object](#tab-panel-223) object **addresses** Array default: nullable **connect-timeout-ms** integer default: 500 nullable \>= 50 <= 4294967295 **interval** integer default: 150 nullable \>= 50 <= 600000 **mesh-seed-address-ports** Array default: nullable **mode** string nullable Allowed values: mesh multicast **mtu** integer nullable <= 4294967295 **multicast-groups** Array default: nullable **multicast-ttl** integer nullable <= 255 **port** integer nullable \>= 1024 <= 65535 **protocol** string default: v3 nullable Allowed values: none v3 **timeout** integer default: 10 nullable \>= 3 <= 4294967295 **tls-addresses** Array default: nullable **tls-mesh-seed-address-ports** Array default: nullable **tls-name** string format: hostname default: null nullable **tls-port** integer nullable \>= 1024 <= 65535 object **addresses** Array default: nullable **connect-timeout-ms** integer default: 500 nullable \>= 50 <= 4294967295 **interval** integer default: 150 nullable \>= 50 <= 600000 **mesh-seed-address-ports** Array default: nullable **mode** string nullable Allowed values: mesh multicast **mtu** integer nullable <= 4294967295 **multicast-groups** Array default: nullable **multicast-ttl** integer nullable <= 255 **port** integer nullable \>= 1024 <= 65535 **protocol** string default: v3 nullable Allowed values: none v3 **timeout** integer default: 10 nullable \>= 3 <= 4294967295 **tls-addresses** Array default: nullable **tls-mesh-seed-address-ports** Array default: nullable **tls-name** string format: hostname default: null nullable **tls-port** integer nullable \>= 1024 <= 65535 **fabric** Any of: - [object](#tab-panel-226) - [object](#tab-panel-227) object **addresses** Array default: nullable **channel-bulk-fds** integer default: 2 nullable \>= 1 <= 128 **channel-bulk-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-ctrl-fds** integer default: 1 nullable \>= 1 <= 128 **channel-ctrl-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-meta-fds** integer default: 1 nullable \>= 1 <= 128 **channel-meta-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-rw-fds** integer default: 8 nullable \>= 1 <= 128 **channel-rw-recv-pools** integer default: 1 nullable \>= 1 <= 16 **channel-rw-recv-threads** integer default: 16 nullable \>= 1 <= 128 **keepalive-enabled** boolean default: true nullable **keepalive-intvl** integer default: 1 nullable \>= 1 <= 2147483647 **keepalive-probes** integer default: 10 nullable \>= 1 <= 2147483647 **keepalive-time** integer default: 1 nullable \>= 1 <= 2147483647 **latency-max-ms** integer default: 5 nullable <= 1000 **port** integer nullable \>= 1024 <= 65535 **recv-rearm-threshold** integer default: 1024 nullable <= 1048576 **send-threads** integer default: 8 nullable \>= 1 <= 128 **tls-addresses** Array default: nullable **tls-name** string format: hostname default: null nullable **tls-port** integer nullable \>= 1024 <= 65535 object **addresses** Array default: nullable **channel-bulk-fds** integer default: 2 nullable \>= 1 <= 128 **channel-bulk-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-ctrl-fds** integer default: 1 nullable \>= 1 <= 128 **channel-ctrl-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-meta-fds** integer default: 1 nullable \>= 1 <= 128 **channel-meta-recv-threads** integer default: 4 nullable \>= 1 <= 128 **channel-rw-fds** integer default: 8 nullable \>= 1 <= 128 **channel-rw-recv-pools** integer default: 1 nullable \>= 1 <= 16 **channel-rw-recv-threads** integer default: 16 nullable \>= 1 <= 128 **keepalive-enabled** boolean default: true nullable **keepalive-intvl** integer default: 1 nullable \>= 1 <= 2147483647 **keepalive-probes** integer default: 10 nullable \>= 1 <= 2147483647 **keepalive-time** integer default: 1 nullable \>= 1 <= 2147483647 **latency-max-ms** integer default: 5 nullable <= 1000 **port** integer nullable \>= 1024 <= 65535 **recv-rearm-threshold** integer default: 1024 nullable <= 1048576 **send-threads** integer default: 8 nullable \>= 1 <= 128 **tls-addresses** Array default: nullable **tls-name** string format: hostname default: null nullable **tls-port** integer nullable \>= 1024 <= 65535 **tls** Array nullable object **name** string format: hostname \>= 1 characters **ca-file** string **ca-path** string **cert-blacklist** string /^\[a-zA-Z0-9./\_-\]\*$/ **cert-file** string /^\[a-zA-Z0-9./\_-\]\*$/ **cipher-suite** string /^\[a-zA-Z0-9- \]\*$/ **key-file** string /^\[a-zA-Z0-9./\_-\]\*$/ **key-file-password** string /^\[a-zA-Z0-9- \]\*$/ **pki-user-append-ou** boolean **protocols** string default: TLSv1.2 /\[a-zA-Z0-9-+\]+/ **namespaces** Array \>= 1 items <= 1 items object **name** required Allowed values: null **active-rack** integer <= 1000000 **allow-ttl-without-nsup** boolean **apply-ttl-reductions** boolean **auto-revive** boolean **background-query-max-rps** integer \>= 1 <= 1000000 **conflict-resolution-policy** string Allowed values: generation last-update-time **conflict-resolve-writes** boolean **default-read-touch-ttl-pct** integer <= 100 **default-ttl** integer <= 315360000 **disable-cold-start-eviction** boolean **disable-mrt-writes** boolean **disable-write-dup-res** boolean **disallow-expunge** boolean **disallow-null-setname** boolean **enable-benchmarks-batch-sub** boolean **enable-benchmarks-ops-sub** boolean **enable-benchmarks-read** boolean **enable-benchmarks-udf** boolean **enable-benchmarks-udf-sub** boolean **enable-benchmarks-write** boolean **enable-hist-proxy** boolean **evict-hist-buckets** integer \>= 100 <= 10000000 **evict-indexes-memory-pct** integer <= 100 **evict-tenths-pct** integer <= 4294967295 **ignore-migrate-fill-delay** boolean **index-stage-size** integer \>= 134217728 <= 17179869184 **indexes-memory-budget** integer <= 18446744073709552000 **inline-short-queries** boolean **max-record-size** integer \>= 64 <= 8388608 **migrate-order** integer \>= 1 <= 10 **migrate-retransmit-ms** integer <= 4294967295 **migrate-skip-unreadable** boolean **migrate-sleep** integer <= 4294967295 **mrt-duration** integer \>= 1 <= 120 **nsup-hist-period** integer <= 4294967295 **nsup-period** integer <= 4294967295 **nsup-threads** integer \>= 1 <= 128 **partition-tree-sprigs** integer \>= 256 <= 268435456 **prefer-uniform-balance** boolean **rack-id** integer <= 1000000 **read-consistency-level-override** string Allowed values: all off one **reject-non-xdr-writes** boolean **reject-xdr-writes** boolean **replication-factor** integer \>= 1 <= 256 **sindex-stage-size** integer \>= 134217728 <= 4294967296 **single-query-threads** integer \>= 1 <= 128 **stop-writes-sys-memory-pct** integer <= 100 **strong-consistency** boolean **strong-consistency-allow-expunge** boolean **tomb-raider-eligible-age** integer <= 4294967295 **tomb-raider-period** integer <= 4294967295 **transaction-pending-limit** integer <= 4294967295 **truncate-threads** integer \>= 1 <= 128 **write-commit-level-override** string Allowed values: all master off **xdr-bin-tombstone-ttl** integer <= 315360000 **xdr-tomb-raider-period** integer <= 4294967295 **xdr-tomb-raider-threads** integer \>= 1 <= 128 **geo2dsphere-within** object **strict** boolean **min-level** integer <= 30 **max-level** integer <= 30 **max-cells** integer \>= 1 <= 256 **level-mod** integer \>= 1 <= 3 **earth-radius-meters** integer <= 4294967295 **index-type** One of: - [object](#tab-panel-208) - [object](#tab-panel-209) - [object](#tab-panel-210) object **type** required string default: shmem Allowed values: shmem object **type** required string default: pmem Allowed values: pmem **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 object **type** required string default: flash Allowed values: flash **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 4294967296 <= 18446744073709552000 **sets** Array object **name** Allowed values: null **default-read-touch-ttl-pct** integer \>= -1 <= 100 **default-ttl** integer <= 315360000 **disable-eviction** boolean **enable-index** boolean **stop-writes-count** integer <= 18446744073709552000 **stop-writes-size** integer <= 18446744073709552000 **sindex-type** One of: - [object](#tab-panel-211) - [object](#tab-panel-212) - [object](#tab-panel-213) object **type** required string default: shmem Allowed values: shmem object **type** required string default: pmem Allowed values: pmem **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 object **type** required string default: flash Allowed values: flash **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 **storage-engine** One of: - [object](#tab-panel-250) - [object](#tab-panel-251) object **type** string Allowed values: memory **commit-to-device** boolean **compression** string Allowed values: none lz4 snappy zstd **compression-acceleration** integer \>= 1 <= 65537 **compression-level** integer \>= 1 <= 9 **data-size** integer \>= 536870912 <= 281474976710656 **defrag-lwm-pct** integer \>= 1 <= 99 **defrag-queue-min** integer <= 4294967295 **defrag-sleep** integer <= 4294967295 **defrag-startup-minimum** integer <= 99 **devices** Array **direct-files** boolean **disable-odsync** boolean **enable-benchmarks-storage** boolean **encryption** string Allowed values: aes-128 aes-256 **encryption-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **encryption-old-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **evict-used-pct** integer <= 100 **files** Array **filesize** integer \>= 134217728 <= 2199023255552 **flush-max-ms** integer <= 1000 **flush-size** integer \>= 4096 <= 8388608 **max-write-cache** integer <= 18446744073709552000 **stop-writes-avail-pct** integer <= 100 **stop-writes-used-pct** integer <= 100 **tomb-raider-sleep** integer <= 4294967295 object **type** string Allowed values: device **cache-replica-writes** boolean **cold-start-empty** boolean **commit-to-device** boolean **compression** string Allowed values: none lz4 snappy zstd **compression-acceleration** integer \>= 1 <= 65537 **compression-level** integer \>= 1 <= 9 **defrag-lwm-pct** integer \>= 1 <= 99 **defrag-queue-min** integer <= 4294967295 **defrag-sleep** integer <= 4294967295 **defrag-startup-minimum** integer <= 99 **devices** Array **direct-files** boolean **disable-odsync** boolean **enable-benchmarks-storage** boolean **encryption** string Allowed values: aes-128 aes-256 **encryption-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **encryption-old-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **evict-used-pct** integer <= 100 **files** Array **filesize** integer \>= 134217728 <= 2199023255552 **flush-max-ms** integer <= 1000 **flush-size** integer \>= 4096 <= 8388608 **max-write-cache** integer <= 18446744073709552000 **post-write-cache** integer <= 18446744073709552000 **read-page-cache** boolean **serialize-tomb-raider** boolean **sindex-startup-device-scan** boolean **stop-writes-avail-pct** integer <= 100 **stop-writes-used-pct** integer <= 100 **tomb-raider-sleep** integer <= 4294967295 **mod-lua** object **cache-enabled** boolean **user-path** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **security** object **default-password-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **enable-quotas** boolean **privilege-refresh-period** integer default: 300 \>= 10 <= 86400 **session-ttl** integer default: 86400 \>= 120 <= 864000 **tps-weight** integer default: 2 \>= 2 <= 20 **ldap** object **disable-tls** boolean **login-threads** integer default: 8 \>= 1 <= 64 **polling-period** integer default: 300 <= 86400 **query-base-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **query-user-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **query-user-password-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **role-query-base-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **role-query-patterns** Array default: **role-query-search-ou** boolean **server** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **tls-ca-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **token-hash-method** string default: sha-256 \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **user-dn-pattern** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **user-query-pattern** string format: regex "" **log** object **report-authentication** boolean **report-data-op** Array default: **report-data-op-role** Array default: **report-data-op-user** Array default: **report-sys-admin** boolean **report-user-admin** boolean **report-violation** boolean **xdr** object **src-id** integer nullable <= 255 **dcs** Array nullable object **name** required string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **auth-mode** string Allowed values: none internal external external-insecure pki **auth-password-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **auth-user** string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **connector** boolean **max-recoveries-interleaved** integer <= 4294967295 **node-address-ports** The address, port and TLS name of the node. The TLS name is optional. Array \>= 1 items <= 3 items Example: \[ "5eb35d27-23fb-4a36-b01e-6efcff9279b4.aerospike.cloud 4000 5eb35d27-23fb-4a36-b01e-6efcff9279b4.aerospike.cloud" \] **period-ms** integer \>= 5 <= 1000 **recovery-threads** integer \>= 1 <= 32 **tls-name** string format: hostname **use-alternate-access-address** boolean **namespaces** required Array \>= 1 items <= 1 items object **name** required string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **bin-policy** string Allowed values: all no-bins only-changed changed-and-specified changed-or-specified **compression-level** integer \>= 1 <= 9 **compression-threshold** integer \>= 128 <= 4294967295 **delay-ms** integer <= 5000 **enable-compression** boolean **forward** boolean **hot-key-ms** integer <= 5000 **ignore-bins** Array **ignore-expunges** boolean **ignore-sets** Array **max-throughput** integer <= 4294967295 **remote-namespace** string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **sc-replication-wait-ms** integer \>= 5 <= 1000 **ship-bins** Array **ship-bin-luts** boolean **ship-nsup-deletes** boolean **ship-only-specified-sets** boolean **ship-sets** Array **ship-versions-interval** integer \>= 1 <= 3600 **ship-versions-policy** string Allowed values: latest all interval **transaction-queue-limit** integer \>= 1024 <= 1048576 **write-policy** string Allowed values: auto update replace ##### Example Example: { "name": "updated-log-access", "logging": { "authorizedRoles": \[ "arn:aws:iam::123456789012:role/ASLogReader", "arn:aws:iam::123456789012:role/ASNewRole" \] } } ## Responses ### 202 A cluster creation, modification, or deletion request has been successfully processed and the current state of applying the requested change is returned. ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema object **id** required Unique identifier for this resource within Aerospike Cloud string Example: e2e81cba-446e-4ff9-9b92-9a9992af44c6 **name** required string Example: My cool cluster **createdAt** required string format: date-time **updatedAt** required string format: date-time **dataPlaneVersion** required string Example: 0.0.1 **connectionDetails** required object **host** Host name that clients will use to connect to the cluster. Correlates to the `AEROSPIKE_CLOUD_HOST` variable in documentation and code samples. string Example: e2e81cba-446e-4ff9-9b92-9a9992af44c6.asdb.io **tlsCertificate** PEM encoded TLS certificate for the cluster. string **logging** object **logBucket** The ARN of the S3 bucket the logs reside in string Example: arn:aws:s3:::db\_logs **authorizedRoles** A list of role ARNs authorized to read the log bucket Array Example: \[ "arn:aws:iam::123456789012:role/ASLogReader" \] **infrastructure** required object **provider** required Cloud provider for the infrastructure string Allowed values: aws gcp **instanceType** required Instance type for vertical scaling string Example: m5d.large **region** required AWS region where resources will be deployed string Example: us-east-1 **availabilityZoneCount** required Number of availability zones to spread resources across integer \>= 1 <= 3 **zoneIds** AWS availability zone IDs for aerospike nodes Array Example: \[ "use1-az1" \] **cidrBlock** IPv4 CIDR block for the database VPC. GCP requires /16; AWS requires /19. string /^((25\[0-5\]|2\[0-4\]\[0-9\]|\[01\]?\[0-9\]\[0-9\]?)\\.){3}(25\[0-5\]|2\[0-4\]\[0-9\]|\[01\]?\[0-9\]\[0-9\]?)/(?:16|19)$/ Example: 10.128.0.0/19 **networkId** The network ID of the database string Example: vpc-01234567890123456 **accountId** The account ID of the database string Example: 123456789012 **networkAttachedStorage** One of: - [gp2](#tab-panel-194) - [gp3](#tab-panel-195) - [io1](#tab-panel-196) - [io2](#tab-panel-197) _gp2_ object **type** required General Purpose SSD (gp2) string Allowed values: gp2 **sizeInGB** required Size of the EBS volume in gigabytes integer \>= 1 _gp3_ object **type** required General Purpose SSD (gp3) string Allowed values: gp3 **iops** required IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema). integer \>= 3000 <= 16000 **sizeInGB** required Size of the EBS volume in gigabytes integer \>= 1 _io1_ object **type** required Provisioned IOPS SSD (io1) string Allowed values: io1 **iops** required IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema). integer \>= 100 <= 64000 **sizeInGB** required Size of the EBS volume in gigabytes (min 4 for io1) integer \>= 4 _io2_ object **type** required Provisioned IOPS SSD (io2) string Allowed values: io2 **iops** required IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema). integer \>= 100 <= 64000 **sizeInGB** required Size of the EBS volume in gigabytes (min 4 for io2) integer \>= 4 **hostedZoneId** The Route 53 hosted zone ID for the database string Example: Z1234567890ABCD **aerospikeCloud** required Any of: - [In-memory database](#tab-panel-214) - [Local disk database](#tab-panel-215) - [Network storage database](#tab-panel-216) object **clusterSize** required Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** required string Allowed values: memory local-disk network-storage **dataStorage** required Allowed values: memory **dataResiliency** Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence. string Allowed values: local-disk network-storage object **clusterSize** required Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** required string Allowed values: memory local-disk network-storage **dataStorage** required Allowed values: local-disk **dataResiliency** Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence. string Allowed values: network-storage object **clusterSize** required Number of nodes in the cluster (horizontal scaling) integer \>= 1 **dataStorage** required string Allowed values: memory local-disk network-storage **dataStorage** required Allowed values: network-storage **aerospikeServer** required Aerospike server configuration object **service** object **advertise-ipv6** boolean **auto-pin** string Allowed values: none cpu numa adq **batch-index-threads** integer \>= 1 <= 256 **batch-max-buffers-per-queue** integer <= 4294967295 **batch-max-requests** integer <= 4294967295 **batch-max-unused-buffers** integer <= 4294967295 **cluster-name** string **debug-allocations** boolean **disable-udf-execution** boolean **enable-benchmarks-fabric** boolean **enable-health-check** boolean **enable-hist-info** boolean **enforce-best-practices** boolean **feature-key-file** string **feature-key-files** Array **group** string **indent-allocations** boolean **info-max-ms** integer \>= 500 <= 10000 **info-threads** integer <= 2147483647 **keep-caps-ssd-health** boolean **log-local-time** boolean **log-millis** boolean **microsecond-histograms** boolean **migrate-fill-delay** integer <= 4294967295 **migrate-max-num-incoming** integer <= 256 **migrate-threads** integer <= 100 **min-cluster-size** integer <= 256 **node-id** string **node-id-interface** string **os-group-perms** boolean **pidfile** string **poison-allocations** boolean **proto-fd-idle-ms** integer <= 2147483647 **proto-fd-max** integer <= 58982 **quarantine-allocations** integer <= 100000000 **query-max-done** integer <= 10000 **query-threads-limit** integer \>= 1 <= 1024 **run-as-daemon** boolean **secrets-address-port** string **secrets-tls-context** string **secrets-uds-path** string **service-threads** integer \>= 1 <= 4096 **sindex-builder-threads** integer \>= 1 <= 32 **sindex-gc-period** integer <= 4294967295 **stay-quiesced** boolean **ticker-interval** integer <= 4294967295 **tls-refresh-period** integer <= 4294967295 **transaction-max-ms** integer <= 4294967295 **transaction-retry-ms** integer <= 4294967295 **user** string **vault-ca** string **vault-namespace** string **vault-path** string **vault-token-file** string **vault-url** string **work-directory** string **logging** Array object **name** string default: \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **misc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **alloc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **arenax** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hardware** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **msg** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **os** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **secrets** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **socket** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **tls** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **vault** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **vmapx** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xmem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **aggr** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **appeal** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **as** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **audit** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **batch** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **batch-sub** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **bin** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **config** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **clustering** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **deprecation** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv-mem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv\_pmem** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **drv\_ssd** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **exchange** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **exp** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **fabric** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **flat** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **geo** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hb** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **health** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **hlc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **index** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **info** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **info-command** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **key-busy** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **migrate** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **mrt-audit** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **mrt-monitor** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **namespace** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **nsup** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **particle** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **partition** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proto** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proxy** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **proxy-divert** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **query** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **record** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **roster** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **rw** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **rw-client** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **security** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **service** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **service-list** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **sindex** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **skew** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **smd** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **storage** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **truncate** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **tsvc** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **udf** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xdr** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **xdr-client** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **masking** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **any** default: CRITICAL Allowed values: CRITICAL critical WARNING warning INFO info DEBUG debug DETAIL detail **facility** default: local0 Allowed values: auth authpriv cron daemon ftp kern lpr mail news syslog user uucp local0 local1 local2 local3 local4 local5 local6 local7 **path** string default: /dev/log \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **tag** string default: asd \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **network** object **service** Any of: - [object](#tab-panel-254) - [object](#tab-panel-255) object **access-addresses** Array default: **access-port** integer \>= 1024 <= 65535 **addresses** Array default: **alternate-access-addresses** Array default: **alternate-access-port** integer \>= 1024 <= 65535 **disable-localhost** boolean **port** required integer \>= 1024 <= 65535 **tls-access-addresses** Array default: **tls-access-port** integer \>= 1024 <= 65535 **tls-addresses** Array default: **tls-alternate-access-addresses** Array default: **tls-alternate-access-port** integer \>= 1024 <= 65535 **tls-authenticate-client** One of: - [string](#tab-panel-178) - [Array](#tab-panel-179) string default: any Allowed values: any false Array **tls-name** string format: hostname **tls-port** integer \>= 1024 <= 65535 object **access-addresses** Array default: **access-port** integer \>= 1024 <= 65535 **addresses** Array default: **alternate-access-addresses** Array default: **alternate-access-port** integer \>= 1024 <= 65535 **disable-localhost** boolean **port** integer \>= 1024 <= 65535 **tls-access-addresses** Array default: **tls-access-port** integer \>= 1024 <= 65535 **tls-addresses** Array default: **tls-alternate-access-addresses** Array default: **tls-alternate-access-port** integer \>= 1024 <= 65535 **tls-authenticate-client** One of: - [string](#tab-panel-180) - [Array](#tab-panel-181) string default: any Allowed values: any false Array **tls-name** required string format: hostname **tls-port** required integer \>= 1024 <= 65535 **admin** Any of: - [object](#tab-panel-248) - [object](#tab-panel-249) object **addresses** Array default: **disable-localhost** boolean **port** required integer \>= 1024 <= 65535 **tls-addresses** Array default: **tls-authenticate-client** One of: - [string](#tab-panel-182) - [Array](#tab-panel-183) string default: any Allowed values: any false Array **tls-name** string "" **tls-port** integer \>= 1024 <= 65535 object **addresses** Array default: **disable-localhost** boolean **port** integer \>= 1024 <= 65535 **tls-addresses** Array default: **tls-authenticate-client** One of: - [string](#tab-panel-184) - [Array](#tab-panel-185) string default: any Allowed values: any false Array **tls-name** required string "" **tls-port** required integer \>= 1024 <= 65535 **heartbeat** Any of: - [object](#tab-panel-220) - [object](#tab-panel-221) object **addresses** Array default: **connect-timeout-ms** integer default: 500 \>= 50 <= 4294967295 **interval** integer default: 150 \>= 50 <= 600000 **mesh-seed-address-ports** Array default: **mode** required string Allowed values: mesh multicast **mtu** integer <= 4294967295 **multicast-groups** Array default: **multicast-ttl** integer <= 255 **port** required integer \>= 1024 <= 65535 **protocol** string default: v3 Allowed values: none v3 **timeout** integer default: 10 \>= 3 <= 4294967295 **tls-addresses** Array default: **tls-mesh-seed-address-ports** Array default: **tls-name** string format: hostname default: null **tls-port** integer \>= 1024 <= 65535 object **addresses** Array default: **connect-timeout-ms** integer default: 500 \>= 50 <= 4294967295 **interval** integer default: 150 \>= 50 <= 600000 **mesh-seed-address-ports** Array default: **mode** required string Allowed values: mesh multicast **mtu** integer <= 4294967295 **multicast-groups** Array default: **multicast-ttl** integer <= 255 **port** integer \>= 1024 <= 65535 **protocol** string default: v3 Allowed values: none v3 **timeout** integer default: 10 \>= 3 <= 4294967295 **tls-addresses** Array default: **tls-mesh-seed-address-ports** Array default: **tls-name** required string format: hostname default: null **tls-port** required integer \>= 1024 <= 65535 **fabric** Any of: - [object](#tab-panel-224) - [object](#tab-panel-225) object **addresses** Array default: **channel-bulk-fds** integer default: 2 \>= 1 <= 128 **channel-bulk-recv-threads** integer default: 4 \>= 1 <= 128 **channel-ctrl-fds** integer default: 1 \>= 1 <= 128 **channel-ctrl-recv-threads** integer default: 4 \>= 1 <= 128 **channel-meta-fds** integer default: 1 \>= 1 <= 128 **channel-meta-recv-threads** integer default: 4 \>= 1 <= 128 **channel-rw-fds** integer default: 8 \>= 1 <= 128 **channel-rw-recv-pools** integer default: 1 \>= 1 <= 16 **channel-rw-recv-threads** integer default: 16 \>= 1 <= 128 **keepalive-enabled** boolean default: true **keepalive-intvl** integer default: 1 \>= 1 <= 2147483647 **keepalive-probes** integer default: 10 \>= 1 <= 2147483647 **keepalive-time** integer default: 1 \>= 1 <= 2147483647 **latency-max-ms** integer default: 5 <= 1000 **port** required integer \>= 1024 <= 65535 **recv-rearm-threshold** integer default: 1024 <= 1048576 **send-threads** integer default: 8 \>= 1 <= 128 **tls-addresses** Array default: **tls-name** string format: hostname default: null **tls-port** integer \>= 1024 <= 65535 object **addresses** Array default: **channel-bulk-fds** integer default: 2 \>= 1 <= 128 **channel-bulk-recv-threads** integer default: 4 \>= 1 <= 128 **channel-ctrl-fds** integer default: 1 \>= 1 <= 128 **channel-ctrl-recv-threads** integer default: 4 \>= 1 <= 128 **channel-meta-fds** integer default: 1 \>= 1 <= 128 **channel-meta-recv-threads** integer default: 4 \>= 1 <= 128 **channel-rw-fds** integer default: 8 \>= 1 <= 128 **channel-rw-recv-pools** integer default: 1 \>= 1 <= 16 **channel-rw-recv-threads** integer default: 16 \>= 1 <= 128 **keepalive-enabled** boolean default: true **keepalive-intvl** integer default: 1 \>= 1 <= 2147483647 **keepalive-probes** integer default: 10 \>= 1 <= 2147483647 **keepalive-time** integer default: 1 \>= 1 <= 2147483647 **latency-max-ms** integer default: 5 <= 1000 **port** integer \>= 1024 <= 65535 **recv-rearm-threshold** integer default: 1024 <= 1048576 **send-threads** integer default: 8 \>= 1 <= 128 **tls-addresses** Array default: **tls-name** required string format: hostname default: null **tls-port** required integer \>= 1024 <= 65535 **tls** Array object **name** string format: hostname \>= 1 characters **ca-file** string **ca-path** string **cert-blacklist** string /^\[a-zA-Z0-9./\_-\]\*$/ **cert-file** string /^\[a-zA-Z0-9./\_-\]\*$/ **cipher-suite** string /^\[a-zA-Z0-9- \]\*$/ **key-file** string /^\[a-zA-Z0-9./\_-\]\*$/ **key-file-password** string /^\[a-zA-Z0-9- \]\*$/ **pki-user-append-ou** boolean **protocols** string default: TLSv1.2 /\[a-zA-Z0-9-+\]+/ **namespaces** required Array \>= 1 items <= 1 items object **name** required Allowed values: null **active-rack** integer <= 1000000 **allow-ttl-without-nsup** boolean **apply-ttl-reductions** boolean **auto-revive** boolean **background-query-max-rps** integer \>= 1 <= 1000000 **conflict-resolution-policy** string Allowed values: generation last-update-time **conflict-resolve-writes** boolean **default-read-touch-ttl-pct** integer <= 100 **default-ttl** integer <= 315360000 **disable-cold-start-eviction** boolean **disable-mrt-writes** boolean **disable-write-dup-res** boolean **disallow-expunge** boolean **disallow-null-setname** boolean **enable-benchmarks-batch-sub** boolean **enable-benchmarks-ops-sub** boolean **enable-benchmarks-read** boolean **enable-benchmarks-udf** boolean **enable-benchmarks-udf-sub** boolean **enable-benchmarks-write** boolean **enable-hist-proxy** boolean **evict-hist-buckets** integer \>= 100 <= 10000000 **evict-indexes-memory-pct** integer <= 100 **evict-tenths-pct** integer <= 4294967295 **ignore-migrate-fill-delay** boolean **index-stage-size** integer \>= 134217728 <= 17179869184 **indexes-memory-budget** integer <= 18446744073709552000 **inline-short-queries** boolean **max-record-size** integer \>= 64 <= 8388608 **migrate-order** integer \>= 1 <= 10 **migrate-retransmit-ms** integer <= 4294967295 **migrate-skip-unreadable** boolean **migrate-sleep** integer <= 4294967295 **mrt-duration** integer \>= 1 <= 120 **nsup-hist-period** integer <= 4294967295 **nsup-period** integer <= 4294967295 **nsup-threads** integer \>= 1 <= 128 **partition-tree-sprigs** integer \>= 256 <= 268435456 **prefer-uniform-balance** boolean **rack-id** integer <= 1000000 **read-consistency-level-override** string Allowed values: all off one **reject-non-xdr-writes** boolean **reject-xdr-writes** boolean **replication-factor** integer \>= 1 <= 256 **sindex-stage-size** integer \>= 134217728 <= 4294967296 **single-query-threads** integer \>= 1 <= 128 **stop-writes-sys-memory-pct** integer <= 100 **strong-consistency** boolean **strong-consistency-allow-expunge** boolean **tomb-raider-eligible-age** integer <= 4294967295 **tomb-raider-period** integer <= 4294967295 **transaction-pending-limit** integer <= 4294967295 **truncate-threads** integer \>= 1 <= 128 **write-commit-level-override** string Allowed values: all master off **xdr-bin-tombstone-ttl** integer <= 315360000 **xdr-tomb-raider-period** integer <= 4294967295 **xdr-tomb-raider-threads** integer \>= 1 <= 128 **geo2dsphere-within** object **strict** boolean **min-level** integer <= 30 **max-level** integer <= 30 **max-cells** integer \>= 1 <= 256 **level-mod** integer \>= 1 <= 3 **earth-radius-meters** integer <= 4294967295 **index-type** One of: - [object](#tab-panel-198) - [object](#tab-panel-199) - [object](#tab-panel-200) object **type** required string default: shmem Allowed values: shmem object **type** required string default: pmem Allowed values: pmem **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 object **type** required string default: flash Allowed values: flash **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 4294967296 <= 18446744073709552000 **sets** Array object **name** Allowed values: null **default-read-touch-ttl-pct** integer \>= -1 <= 100 **default-ttl** integer <= 315360000 **disable-eviction** boolean **enable-index** boolean **stop-writes-count** integer <= 18446744073709552000 **stop-writes-size** integer <= 18446744073709552000 **sindex-type** One of: - [object](#tab-panel-201) - [object](#tab-panel-202) - [object](#tab-panel-203) object **type** required string default: shmem Allowed values: shmem object **type** required string default: pmem Allowed values: pmem **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 object **type** required string default: flash Allowed values: flash **evict-mounts-pct** integer <= 100 **mounts** required Array default: **mounts-budget** required integer \>= 1073741824 <= 18446744073709552000 **storage-engine** One of: - [object](#tab-panel-228) - [object](#tab-panel-229) object **type** string Allowed values: memory **commit-to-device** boolean **compression** string Allowed values: none lz4 snappy zstd **compression-acceleration** integer \>= 1 <= 65537 **compression-level** integer \>= 1 <= 9 **data-size** integer \>= 536870912 <= 281474976710656 **defrag-lwm-pct** integer \>= 1 <= 99 **defrag-queue-min** integer <= 4294967295 **defrag-sleep** integer <= 4294967295 **defrag-startup-minimum** integer <= 99 **devices** Array **direct-files** boolean **disable-odsync** boolean **enable-benchmarks-storage** boolean **encryption** string Allowed values: aes-128 aes-256 **encryption-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **encryption-old-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **evict-used-pct** integer <= 100 **files** Array **filesize** integer \>= 134217728 <= 2199023255552 **flush-max-ms** integer <= 1000 **flush-size** integer \>= 4096 <= 8388608 **max-write-cache** integer <= 18446744073709552000 **stop-writes-avail-pct** integer <= 100 **stop-writes-used-pct** integer <= 100 **tomb-raider-sleep** integer <= 4294967295 object **type** string Allowed values: device **cache-replica-writes** boolean **cold-start-empty** boolean **commit-to-device** boolean **compression** string Allowed values: none lz4 snappy zstd **compression-acceleration** integer \>= 1 <= 65537 **compression-level** integer \>= 1 <= 9 **defrag-lwm-pct** integer \>= 1 <= 99 **defrag-queue-min** integer <= 4294967295 **defrag-sleep** integer <= 4294967295 **defrag-startup-minimum** integer <= 99 **devices** Array **direct-files** boolean **disable-odsync** boolean **enable-benchmarks-storage** boolean **encryption** string Allowed values: aes-128 aes-256 **encryption-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **encryption-old-key-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **evict-used-pct** integer <= 100 **files** Array **filesize** integer \>= 134217728 <= 2199023255552 **flush-max-ms** integer <= 1000 **flush-size** integer \>= 4096 <= 8388608 **max-write-cache** integer <= 18446744073709552000 **post-write-cache** integer <= 18446744073709552000 **read-page-cache** boolean **serialize-tomb-raider** boolean **sindex-startup-device-scan** boolean **stop-writes-avail-pct** integer <= 100 **stop-writes-used-pct** integer <= 100 **tomb-raider-sleep** integer <= 4294967295 **mod-lua** object **cache-enabled** boolean **user-path** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **security** object **default-password-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **enable-quotas** boolean **privilege-refresh-period** integer default: 300 \>= 10 <= 86400 **session-ttl** integer default: 86400 \>= 120 <= 864000 **tps-weight** integer default: 2 \>= 2 <= 20 **ldap** object **disable-tls** boolean **login-threads** integer default: 8 \>= 1 <= 64 **polling-period** integer default: 300 <= 86400 **query-base-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **query-user-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **query-user-password-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **role-query-base-dn** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **role-query-patterns** Array default: **role-query-search-ou** boolean **server** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **tls-ca-file** string "" /^\[a-zA-Z0-9./\_-\]\*$/ **token-hash-method** string default: sha-256 \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **user-dn-pattern** string "" /^\[a-zA-Z0-9-\\\\ \]\*$/ **user-query-pattern** string format: regex "" **log** object **report-authentication** boolean **report-data-op** Array default: **report-data-op-role** Array default: **report-data-op-user** Array default: **report-sys-admin** boolean **report-user-admin** boolean **report-violation** boolean **xdr** object **src-id** integer <= 255 **dcs** Array object **name** required string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **auth-mode** string Allowed values: none internal external external-insecure pki **auth-password-file** string \>= 1 characters /^\[a-zA-Z0-9./\_-\]\*$/ **auth-user** string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **connector** boolean **max-recoveries-interleaved** integer <= 4294967295 **node-address-ports** The address, port and TLS name of the node. The TLS name is optional. Array \>= 1 items <= 3 items Example: \[ "5eb35d27-23fb-4a36-b01e-6efcff9279b4.aerospike.cloud 4000 5eb35d27-23fb-4a36-b01e-6efcff9279b4.aerospike.cloud" \] **period-ms** integer \>= 5 <= 1000 **recovery-threads** integer \>= 1 <= 32 **tls-name** string format: hostname **use-alternate-access-address** boolean **namespaces** required Array \>= 1 items <= 1 items object **name** required string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **bin-policy** string Allowed values: all no-bins only-changed changed-and-specified changed-or-specified **compression-level** integer \>= 1 <= 9 **compression-threshold** integer \>= 128 <= 4294967295 **delay-ms** integer <= 5000 **enable-compression** boolean **forward** boolean **hot-key-ms** integer <= 5000 **ignore-bins** Array **ignore-expunges** boolean **ignore-sets** Array **max-throughput** integer <= 4294967295 **remote-namespace** string \>= 1 characters /^\[a-zA-Z0-9- \]\*$/ **sc-replication-wait-ms** integer \>= 5 <= 1000 **ship-bins** Array **ship-bin-luts** boolean **ship-nsup-deletes** boolean **ship-only-specified-sets** boolean **ship-sets** Array **ship-versions-interval** integer \>= 1 <= 3600 **ship-versions-policy** string Allowed values: latest all interval **transaction-queue-limit** integer \>= 1024 <= 1048576 **write-policy** string Allowed values: auto update replace **health** object **state** string Allowed values: ONLINE OFFLINE UNSPECIFIED Example: ONLINE **status** string Allowed values: not-available provisioning active updating decommissioning decommissioned pausing paused resuming action-required config-error usage-exceeded multiple unknown Example: active ##### Example Content type: application/json Copied! {  { "id": "e2e81cba-446e-4ff9-9b92-9a9992af44c6", "name": "My cool cluster", "createdAt": "string", "updatedAt": "string", "dataPlaneVersion": "0.0.1", "connectionDetails": {  "host": "e2e81cba-446e-4ff9-9b92-9a9992af44c6.asdb.io", "tlsCertificate": "string" }, "logging": {  "logBucket": "arn:aws:s3:::db\_logs", "authorizedRoles": \[  "string" \] }, "infrastructure": {  "provider": "aws", "instanceType": "m5d.large", "region": "us-east-1", "availabilityZoneCount": 1, "zoneIds": \[  "string" \], "cidrBlock": "10.128.0.0/19", "networkId": "vpc-01234567890123456", "accountId": "123456789012", "networkAttachedStorage": , "hostedZoneId": "Z1234567890ABCD" }, "aerospikeCloud": {  "clusterSize": 1, "dataStorage": "memory", "dataResiliency": "local-disk" }, "aerospikeServer": {  "service": {  "advertise-ipv6": "boolean", "auto-pin": "none", "batch-index-threads": 1, "batch-max-buffers-per-queue": "integer", "batch-max-requests": "integer", "batch-max-unused-buffers": "integer", "cluster-name": "string", "debug-allocations": "boolean", "disable-udf-execution": "boolean", "enable-benchmarks-fabric": "boolean", "enable-health-check": "boolean", "enable-hist-info": "boolean", "enforce-best-practices": "boolean", "feature-key-file": "string", "feature-key-files": \[  "string" \], "group": "string", "indent-allocations": "boolean", "info-max-ms": 500, "info-threads": "integer", "keep-caps-ssd-health": "boolean", "log-local-time": "boolean", "log-millis": "boolean", "microsecond-histograms": "boolean", "migrate-fill-delay": "integer", "migrate-max-num-incoming": "integer", "migrate-threads": "integer", "min-cluster-size": "integer", "node-id": "string", "node-id-interface": "string", "os-group-perms": "boolean", "pidfile": "string", "poison-allocations": "boolean", "proto-fd-idle-ms": "integer", "proto-fd-max": "integer", "quarantine-allocations": "integer", "query-max-done": "integer", "query-threads-limit": 1, "run-as-daemon": "boolean", "secrets-address-port": "string", "secrets-tls-context": "string", "secrets-uds-path": "string", "service-threads": 1, "sindex-builder-threads": 1, "sindex-gc-period": "integer", "stay-quiesced": "boolean", "ticker-interval": "integer", "tls-refresh-period": "integer", "transaction-max-ms": "integer", "transaction-retry-ms": "integer", "user": "string", "vault-ca": "string", "vault-namespace": "string", "vault-path": "string", "vault-token-file": "string", "vault-url": "string", "work-directory": "string" }, "logging": \[  {  "name": "string", "misc": "CRITICAL", "alloc": "CRITICAL", "arenax": "CRITICAL", "hardware": "CRITICAL", "msg": "CRITICAL", "os": "CRITICAL", "secrets": "CRITICAL", "socket": "CRITICAL", "tls": "CRITICAL", "vault": "CRITICAL", "vmapx": "CRITICAL", "xmem": "CRITICAL", "aggr": "CRITICAL", "appeal": "CRITICAL", "as": "CRITICAL", "audit": "CRITICAL", "batch": "CRITICAL", "batch-sub": "CRITICAL", "bin": "CRITICAL", "config": "CRITICAL", "clustering": "CRITICAL", "deprecation": "CRITICAL", "drv-mem": "CRITICAL", "drv\_pmem": "CRITICAL", "drv\_ssd": "CRITICAL", "exchange": "CRITICAL", "exp": "CRITICAL", "fabric": "CRITICAL", "flat": "CRITICAL", "geo": "CRITICAL", "hb": "CRITICAL", "health": "CRITICAL", "hlc": "CRITICAL", "index": "CRITICAL", "info": "CRITICAL", "info-command": "CRITICAL", "key-busy": "CRITICAL", "migrate": "CRITICAL", "mrt-audit": "CRITICAL", "mrt-monitor": "CRITICAL", "namespace": "CRITICAL", "nsup": "CRITICAL", "particle": "CRITICAL", "partition": "CRITICAL", "proto": "CRITICAL", "proxy": "CRITICAL", "proxy-divert": "CRITICAL", "query": "CRITICAL", "record": "CRITICAL", "roster": "CRITICAL", "rw": "CRITICAL", "rw-client": "CRITICAL", "security": "CRITICAL", "service": "CRITICAL", "service-list": "CRITICAL", "sindex": "CRITICAL", "skew": "CRITICAL", "smd": "CRITICAL", "storage": "CRITICAL", "truncate": "CRITICAL", "tsvc": "CRITICAL", "udf": "CRITICAL", "xdr": "CRITICAL", "xdr-client": "CRITICAL", "masking": "CRITICAL", "any": "CRITICAL", "facility": "auth", "path": "string", "tag": "string" } \], "network": {  "service": , "admin": , "heartbeat": , "fabric": , "tls": \[  {  "name": "string", "ca-file": "string", "ca-path": "string", "cert-blacklist": "string", "cert-file": "string", "cipher-suite": "string", "key-file": "string", "key-file-password": "string", "pki-user-append-ou": "boolean", "protocols": "string" } \] }, "namespaces": \[  {  "name": "string", "active-rack": "integer", "allow-ttl-without-nsup": "boolean", "apply-ttl-reductions": "boolean", "auto-revive": "boolean", "background-query-max-rps": 1, "conflict-resolution-policy": "generation", "conflict-resolve-writes": "boolean", "default-read-touch-ttl-pct": "integer", "default-ttl": "integer", "disable-cold-start-eviction": "boolean", "disable-mrt-writes": "boolean", "disable-write-dup-res": "boolean", "disallow-expunge": "boolean", "disallow-null-setname": "boolean", "enable-benchmarks-batch-sub": "boolean", "enable-benchmarks-ops-sub": "boolean", "enable-benchmarks-read": "boolean", "enable-benchmarks-udf": "boolean", "enable-benchmarks-udf-sub": "boolean", "enable-benchmarks-write": "boolean", "enable-hist-proxy": "boolean", "evict-hist-buckets": 100, "evict-indexes-memory-pct": "integer", "evict-tenths-pct": "integer", "ignore-migrate-fill-delay": "boolean", "index-stage-size": 134217728, "indexes-memory-budget": "integer", "inline-short-queries": "boolean", "max-record-size": 64, "migrate-order": 1, "migrate-retransmit-ms": "integer", "migrate-skip-unreadable": "boolean", "migrate-sleep": "integer", "mrt-duration": 1, "nsup-hist-period": "integer", "nsup-period": "integer", "nsup-threads": 1, "partition-tree-sprigs": 256, "prefer-uniform-balance": "boolean", "rack-id": "integer", "read-consistency-level-override": "all", "reject-non-xdr-writes": "boolean", "reject-xdr-writes": "boolean", "replication-factor": 1, "sindex-stage-size": 134217728, "single-query-threads": 1, "stop-writes-sys-memory-pct": "integer", "strong-consistency": "boolean", "strong-consistency-allow-expunge": "boolean", "tomb-raider-eligible-age": "integer", "tomb-raider-period": "integer", "transaction-pending-limit": "integer", "truncate-threads": 1, "write-commit-level-override": "all", "xdr-bin-tombstone-ttl": "integer", "xdr-tomb-raider-period": "integer", "xdr-tomb-raider-threads": 1, "geo2dsphere-within": {  "strict": "boolean", "min-level": "integer", "max-level": "integer", "max-cells": 1, "level-mod": 1, "earth-radius-meters": "integer" }, "index-type": , "sets": \[  {  "name": "string", "default-read-touch-ttl-pct": \-1, "default-ttl": "integer", "disable-eviction": "boolean", "enable-index": "boolean", "stop-writes-count": "integer", "stop-writes-size": "integer" } \], "sindex-type": , "storage-engine": } \], "mod-lua": {  "cache-enabled": "boolean", "user-path": "string" }, "security": {  "default-password-file": "string", "enable-quotas": "boolean", "privilege-refresh-period": 10, "session-ttl": 120, "tps-weight": 2, "ldap": {  "disable-tls": "boolean", "login-threads": 1, "polling-period": "integer", "query-base-dn": "string", "query-user-dn": "string", "query-user-password-file": "string", "role-query-base-dn": "string", "role-query-patterns": \[  "string" \], "role-query-search-ou": "boolean", "server": "string", "tls-ca-file": "string", "token-hash-method": "string", "user-dn-pattern": "string", "user-query-pattern": "string" }, "log": {  "report-authentication": "boolean", "report-data-op": \[  "string" \], "report-data-op-role": \[  "string" \], "report-data-op-user": \[  "string" \], "report-sys-admin": "boolean", "report-user-admin": "boolean", "report-violation": "boolean" } }, "xdr": {  "src-id": "integer", "dcs": \[  {  "name": "string", "auth-mode": "none", "auth-password-file": "string", "auth-user": "string", "connector": "boolean", "max-recoveries-interleaved": "integer", "node-address-ports": \[  "string" \], "period-ms": 5, "recovery-threads": 1, "tls-name": "string", "use-alternate-access-address": "boolean", "namespaces": \[  {  "name": "string", "bin-policy": "all", "compression-level": 1, "compression-threshold": 128, "delay-ms": "integer", "enable-compression": "boolean", "forward": "boolean", "hot-key-ms": "integer", "ignore-bins": \[  "string" \], "ignore-expunges": "boolean", "ignore-sets": \[  "string" \], "max-throughput": "integer", "remote-namespace": "string", "sc-replication-wait-ms": 5, "ship-bins": \[  "string" \], "ship-bin-luts": "boolean", "ship-nsup-deletes": "boolean", "ship-only-specified-sets": "boolean", "ship-sets": \[  "string" \], "ship-versions-interval": 1, "ship-versions-policy": "latest", "transaction-queue-limit": 1024, "write-policy": "auto" } \] } \] } }, "health": {  "state": "ONLINE", "status": "active" } } ### 400 Invalid input ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-230) - [object](#tab-panel-231) - [object](#tab-panel-232) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:validation:failed", "title": "Validation Error", "status": 400, "detail": "The provided information is not in the correct format.", "instance": "string", "context": { "invalid": \[ { "field": "/name", "type": "urn:aerospike:errors:validation:too-long" }, { "field": "/region", "type": "urn:aerospike:errors:validation:too-short" } \] }, "message": "The provided information is not in the correct format." } ### 401 Access token is missing or invalid ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-233) - [object](#tab-panel-234) - [object](#tab-panel-235) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:auth:token-expired", "title": "Token Expired", "status": 401, "detail": "Your session has expired. Please log in again.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "Your session has expired. Please log in again." } ### 403 Permission denied ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-236) - [object](#tab-panel-237) - [object](#tab-panel-238) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:auth:unauthorized", "title": "Unauthorized", "status": 403, "detail": "You don't have permission to access this resource.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "You don't have permission to access this resource." } ### 404 Resource not found ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-239) - [object](#tab-panel-240) - [object](#tab-panel-241) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:resource:not-found", "title": "Resource Not Found", "status": 404, "detail": "The requested resource could not be found.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "The requested resource could not be found." } ### 409 Conflict error ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-242) - [object](#tab-panel-243) - [object](#tab-panel-244) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:resource:already-exists", "title": "Resource Already Exists", "status": 409, "detail": "A resource with this name already exists.", "instance": "string", "context": { "resource": "cluster", "id": "my-cluster" }, "message": "A resource with this name already exists." } ### 500 Internal Server Error ##### Response Headers **X-Request-Id** string Example: b0658b67-8ea3-46de-a3b8-18c3f5347def ID uniquely identifying the request/response cycle. ##### Response Schema RFC 9457 Problem Details for HTTP APIs. Provides a standardized format for conveying error details in HTTP responses. object **type** required URN-based error type identifiers following the pattern: urn:aerospike:errors:{category}:{specific} Resource information (cluster, database, organization, etc.) is provided in the ProblemDetails context field, not in the URN. string Allowed values: urn:aerospike:errors:auth:unauthorized urn:aerospike:errors:auth:token-expired urn:aerospike:errors:resource:not-found urn:aerospike:errors:resource:already-exists urn:aerospike:errors:validation:failed urn:aerospike:errors:system:internal urn:aerospike:errors:system:unavailable urn:aerospike:errors:ratelimit:exceeded **title** required A short, human-readable summary of the problem type string Example: Resource Not Found **status** required The HTTP status code integer Example: 404 **detail** A human-readable explanation specific to this occurrence string Example: The requested cluster could not be found. **instance** A URI reference that identifies the specific occurrence string format: uri **context** Any of: - [object](#tab-panel-245) - [object](#tab-panel-246) - [object](#tab-panel-247) Context for resource-related errors (not-found, already-exists) object **resource** Type of resource (e.g., cluster, database, organization) string Example: cluster **id** Identifier of the resource string Example: abc-123 Structured context for validation errors object **missing** JSON Pointer paths to missing required fields Array Example: \[ "/user/email", "/user/password", "/user/firstName" \] **invalid** Details about invalid field values Array object **field** required JSON Pointer path to the invalid field string Example: /user/phoneNumber **type** required URN identifying the specific validation error type string format: uri Allowed values: urn:aerospike:errors:validation:failed urn:aerospike:errors:validation:invalid-phone-format urn:aerospike:errors:validation:invalid-email-format urn:aerospike:errors:validation:invalid-date-format urn:aerospike:errors:validation:invalid-url-format urn:aerospike:errors:validation:out-of-range urn:aerospike:errors:validation:too-long urn:aerospike:errors:validation:too-short Example: urn:aerospike:errors:validation:failed **description** An optional human-readable description of the validation error string object **_key_** additional properties any **message** Developer-friendly message explaining the error. Deprecated: Use ‘detail’ field instead. string Example: The requested cluster could not be found. ##### Example Example: { "type": "urn:aerospike:errors:system:internal", "title": "Internal Server Error", "status": 500, "detail": "An unexpected error occurred. Please try again later.", "instance": "string", "context": { "resource": "cluster", "id": "abc-123" }, "message": "An unexpected error occurred. Please try again later." }