Get an existing database
GET /databases/{databaseId}
GET
/databases/{databaseId}
Get an existing database by Id
Authorizations
Parameters
Path Parameters
databaseId
required
string
format: uuid
A database ID.
Responses
200
A database creation, modification, or deletion request has been successfully processed and the current state of applying the requested change is returned including metrics.
Response Headers
X-Request-Id
string
Example: b0658b67-8ea3-46de-a3b8-18c3f5347def
ID uniquely identifying the request/response cycle.
Response Schema
object
id
Unique identifier for this resource within Aerospike Cloud
string
Example: e2e81cba-446e-4ff9-9b92-9a9992af44c6
name
required
string
Example: My cool database
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 database. 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 database.
string
infrastructure
required
object
provider
required
Cloud provider for the infrastructure
string
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
zoneIds
AWS availability zone IDs for aerospike nodes
Array<string>
Example: [
"use1-az1"
]
cidrBlock
The /19 IPv4 CIDR block for the database VPC
string
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
object
type
required
General Purpose SSD (gp2)
string
sizeInGB
required
Size of the EBS volume in gigabytes
integer
gp3
object
type
required
General Purpose SSD (gp3)
string
iops
required
IOPS for gp3 (min 3000, max 16000). Max 500 IOPS per GB (not enforced by schema).
integer
sizeInGB
required
Size of the EBS volume in gigabytes
integer
io1
object
type
required
Provisioned IOPS SSD (io1)
string
iops
required
IOPS for io1 (min 100, max 64000). Max 50 IOPS per GB (not enforced by schema).
integer
sizeInGB
required
Size of the EBS volume in gigabytes (min 4 for io1)
integer
io2
object
type
required
Provisioned IOPS SSD (io2)
string
iops
required
IOPS for io2 (min 100, max 64000). Max 1000 IOPS per GB (not enforced by schema).
integer
sizeInGB
required
Size of the EBS volume in gigabytes (min 4 for io2)
integer
aerospikeCloud
required
Any of:
object
clusterSize
required
Number of nodes in the cluster (horizontal scaling)
integer
dataStorage
required
string
dataStorage
required
dataResiliency
Persist data using local disks or network storage. If omitted, data is stored in-memory without persistence.
string
object
clusterSize
required
Number of nodes in the cluster (horizontal scaling)
integer
dataStorage
required
string
dataStorage
required
dataResiliency
Persist data using network storage. If omitted, data is stored only on local SSDs without additional persistence.
string
object
clusterSize
required
Number of nodes in the cluster (horizontal scaling)
integer
dataStorage
required
string
dataStorage
required
aerospikeServer
required
Aerospike server configuration
object
service
object
advertise-ipv6
boolean
auto-pin
string
batch-index-threads
integer
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
Array<string>
group
string
indent-allocations
boolean
info-max-ms
integer
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
integer
run-as-daemon
boolean
secrets-address-port
string
secrets-tls-context
string
secrets-uds-path
string
service-threads
integer
sindex-builder-threads
integer
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
Array<object>
object
name
string
misc
alloc
arenax
hardware
msg
os
secrets
socket
tls
vault
vmapx
xmem
aggr
appeal
as
audit
batch
batch-sub
bin
config
clustering
drv-mem
drv_pmem
drv_ssd
exchange
exp
fabric
flat
geo
hb
health
hlc
index
info
info-command
info-port
key-busy
migrate
mrt-audit
mrt-monitor
namespace
nsup
particle
partition
proto
proxy
proxy-divert
query
record
roster
rw
rw-client
security
service
service-list
sindex
skew
smd
storage
truncate
tsvc
udf
xdr
xdr-client
any
facility
path
string
tag
string
network
object
service
required
Any of:
object
access-addresses
Array<string>
access-port
integer
addresses
Array<string>
alternate-access-addresses
Array<string>
alternate-access-port
integer
disable-localhost
boolean
port
required
integer
tls-access-addresses
Array<string>
tls-access-port
integer
tls-addresses
Array<string>
tls-alternate-access-addresses
Array<string>
tls-alternate-access-port
integer
tls-authenticate-client
One of:
string
Array<string>
tls-name
string
tls-port
integer
object
access-addresses
Array<string>
access-port
integer
addresses
Array<string>
alternate-access-addresses
Array<string>
alternate-access-port
integer
disable-localhost
boolean
port
integer
tls-access-addresses
Array<string>
tls-access-port
integer
tls-addresses
Array<string>
tls-alternate-access-addresses
Array<string>
tls-alternate-access-port
integer
tls-authenticate-client
One of:
string
Array<string>
tls-name
required
string
tls-port
required
integer
heartbeat
required
Any of:
object
addresses
Array<string>
connect-timeout-ms
integer
interval
integer
mesh-seed-address-ports
Array<string>
mode
required
string
mtu
integer
multicast-groups
Array<string>
multicast-ttl
integer
port
required
integer
protocol
string
timeout
integer
tls-addresses
Array<string>
tls-mesh-seed-address-ports
Array<string>
tls-name
string
tls-port
integer
object
addresses
Array<string>
connect-timeout-ms
integer
interval
integer
mesh-seed-address-ports
Array<string>
mode
required
string
mtu
integer
multicast-groups
Array<string>
multicast-ttl
integer
port
integer
protocol
string
timeout
integer
tls-addresses
Array<string>
tls-mesh-seed-address-ports
Array<string>
tls-name
required
string
tls-port
required
integer
fabric
required
Any of:
object
addresses
Array<string>
channel-bulk-fds
integer
channel-bulk-recv-threads
integer
channel-ctrl-fds
integer
channel-ctrl-recv-threads
integer
channel-meta-fds
integer
channel-meta-recv-threads
integer
channel-rw-fds
integer
channel-rw-recv-pools
integer
channel-rw-recv-threads
integer
keepalive-enabled
boolean
keepalive-intvl
integer
keepalive-probes
integer
keepalive-time
integer
latency-max-ms
integer
port
required
integer
recv-rearm-threshold
integer
send-threads
integer
tls-addresses
Array<string>
tls-name
string
tls-port
integer
object
addresses
Array<string>
channel-bulk-fds
integer
channel-bulk-recv-threads
integer
channel-ctrl-fds
integer
channel-ctrl-recv-threads
integer
channel-meta-fds
integer
channel-meta-recv-threads
integer
channel-rw-fds
integer
channel-rw-recv-pools
integer
channel-rw-recv-threads
integer
keepalive-enabled
boolean
keepalive-intvl
integer
keepalive-probes
integer
keepalive-time
integer
latency-max-ms
integer
port
integer
recv-rearm-threshold
integer
send-threads
integer
tls-addresses
Array<string>
tls-name
required
string
tls-port
required
integer
info
object
addresses
Array<string>
port
integer
tls
Array<object>
object
name
string
ca-file
string
ca-path
string
cert-blacklist
string
cert-file
string
cipher-suite
string
key-file
string
key-file-password
string
protocols
string
namespaces
required
Array<object>
object
name
required
string
active-rack
integer
allow-ttl-without-nsup
boolean
auto-revive
boolean
background-query-max-rps
integer
conflict-resolution-policy
string
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
integer
evict-indexes-memory-pct
integer
evict-tenths-pct
integer
ignore-migrate-fill-delay
boolean
index-stage-size
integer
indexes-memory-budget
integer
inline-short-queries
boolean
max-record-size
integer
migrate-order
integer
migrate-retransmit-ms
integer
migrate-skip-unreadable
boolean
migrate-sleep
integer
mrt-duration
integer
nsup-hist-period
integer
nsup-period
integer
nsup-threads
integer
partition-tree-sprigs
integer
prefer-uniform-balance
boolean
rack-id
integer
read-consistency-level-override
string
reject-non-xdr-writes
boolean
reject-xdr-writes
boolean
replication-factor
integer
sindex-stage-size
integer
single-query-threads
integer
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
integer
write-commit-level-override
string
xdr-bin-tombstone-ttl
integer
xdr-tomb-raider-period
integer
xdr-tomb-raider-threads
integer
geo2dsphere-within
object
strict
boolean
min-level
integer
max-level
integer
max-cells
integer
level-mod
integer
earth-radius-meters
integer
index-type
One of:
object
type
required
string
object
type
required
string
evict-mounts-pct
integer
mounts
required
Array<string>
mounts-budget
required
integer
object
type
required
string
evict-mounts-pct
integer
mounts
required
Array<string>
mounts-budget
required
integer
sets
Array<object>
object
name
string
default-read-touch-ttl-pct
integer
default-ttl
integer
disable-eviction
boolean
enable-index
boolean
stop-writes-count
integer
stop-writes-size
integer
sindex-type
One of:
object
type
required
string
object
type
required
string
evict-mounts-pct
integer
mounts
required
Array<string>
mounts-budget
required
integer
object
type
required
string
evict-mounts-pct
integer
mounts
required
Array<string>
mounts-budget
required
integer
storage-engine
One of:
object
type
string
commit-to-device
boolean
compression
string
compression-acceleration
integer
compression-level
integer
data-size
integer
defrag-lwm-pct
integer
defrag-queue-min
integer
defrag-sleep
integer
defrag-startup-minimum
integer
devices
Array<string>
direct-files
boolean
disable-odsync
boolean
enable-benchmarks-storage
boolean
encryption
string
encryption-key-file
string
encryption-old-key-file
string
evict-used-pct
integer
files
Array<string>
filesize
integer
flush-max-ms
integer
flush-size
integer
max-write-cache
integer
stop-writes-avail-pct
integer
stop-writes-used-pct
integer
tomb-raider-sleep
integer
object
type
string
cache-replica-writes
boolean
cold-start-empty
boolean
commit-to-device
boolean
compression
string
compression-acceleration
integer
compression-level
integer
defrag-lwm-pct
integer
defrag-queue-min
integer
defrag-sleep
integer
defrag-startup-minimum
integer
devices
Array<string>
direct-files
boolean
disable-odsync
boolean
enable-benchmarks-storage
boolean
encryption
string
encryption-key-file
string
encryption-old-key-file
string
evict-used-pct
integer
files
Array<string>
filesize
integer
flush-max-ms
integer
flush-size
integer
max-write-cache
integer
post-write-cache
integer
read-page-cache
boolean
serialize-tomb-raider
boolean
sindex-startup-device-scan
boolean
stop-writes-avail-pct
integer
stop-writes-used-pct
integer
tomb-raider-sleep
integer
mod-lua
object
cache-enabled
boolean
user-path
string
security
object
default-password-file
string
enable-quotas
boolean
privilege-refresh-period
integer
session-ttl
integer
tps-weight
integer
ldap
object
disable-tls
boolean
login-threads
integer
polling-period
integer
query-base-dn
string
query-user-dn
string
query-user-password-file
string
role-query-base-dn
string
role-query-patterns
Array<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
object
report-authentication
boolean
report-data-op
Array<string>
report-data-op-role
Array<string>
report-data-op-user
Array<string>
report-sys-admin
boolean
report-user-admin
boolean
report-violation
boolean
xdr
object
src-id
integer
dcs
Array<object>
object
name
string
auth-mode
string
auth-password-file
string
auth-user
string
connector
boolean
max-recoveries-interleaved
integer
node-address-ports
Array<string>
period-ms
integer
tls-name
string
use-alternate-access-address
boolean
namespaces
Array<object>
object
name
string
bin-policy
string
compression-level
integer
compression-threshold
integer
delay-ms
integer
enable-compression
boolean
forward
boolean
hot-key-ms
integer
ignore-bins
Array<string>
ignore-expunges
boolean
ignore-sets
Array<string>
max-throughput
integer
remote-namespace
string
sc-replication-wait-ms
integer
ship-bins
Array<string>
ship-bin-luts
boolean
ship-nsup-deletes
boolean
ship-only-specified-sets
boolean
ship-sets
Array<string>
ship-versions-interval
integer
ship-versions-policy
string
transaction-queue-limit
integer
write-policy
string
health
object
state
string
Example: ONLINE
status
string
Example: active
Example
Copied!
{
{
"id": "e2e81cba-446e-4ff9-9b92-9a9992af44c6",
"name": "My cool database",
"createdAt": "string",
"updatedAt": "string",
"dataPlaneVersion": "0.0.1",
"connectionDetails": {
"host": "e2e81cba-446e-4ff9-9b92-9a9992af44c6.asdb.io",
"tlsCertificate": "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":
},
"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",
"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",
"info-port": "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",
"any": "CRITICAL",
"facility": "auth",
"path": "string",
"tag": "string"
}
],
"network": {
"service": ,
"heartbeat": ,
"fabric": ,
"info": {
"addresses": [
"string"
],
"port": 1024
},
"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",
"protocols": "string"
}
]
},
"namespaces": [
{
"name": "string",
"active-rack": "integer",
"allow-ttl-without-nsup": "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,
"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
Generic API error
object
code
Unique (system-wide) error code for an error happened
string
message
required
Developer-friendly message explaining error
string
key
additional properties
any
Example
Copied!
{
{
"code": "string",
"message": "string"
}
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
Generic API error
object
code
Unique (system-wide) error code for an error happened
string
message
required
Developer-friendly message explaining error
string
key
additional properties
any
Example
Copied!
{
{
"code": "invalid_token",
"message": "The access token expired."
}
403
Permission denied
Response Headers
X-Request-Id
string
Example: b0658b67-8ea3-46de-a3b8-18c3f5347def
ID uniquely identifying the request/response cycle.
Response Schema
Generic API error
object
code
Unique (system-wide) error code for an error happened
string
message
required
Developer-friendly message explaining error
string
key
additional properties
any
Example
Copied!
{
{
"code": "string",
"message": "string"
}
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
Generic API error
object
code
Unique (system-wide) error code for an error happened
string
message
required
Developer-friendly message explaining error
string
key
additional properties
any
Example
Copied!
{
{
"code": "string",
"message": "string"
}
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
Generic API error
object
code
Unique (system-wide) error code for an error happened
string
message
required
Developer-friendly message explaining error
string
key
additional properties
any
Example
Copied!
{
{
"code": "string",
"message": "string"
}