Previous Next JavaScript must be enabled to correctly display this content

## All REST Endpoints

Sort by
Task Path Method
Group by API
Administration
Encapsulates commands that administer, manage, and configure the store.

await-consistent
  Method: post
  Path: `/V0/nosql/admin#await-consistent`
change-policy
  Method: post
  Path: `/V0/nosql/admin#change-policy`
configure
  Method: post
  Path: `/V0/nosql/admin#configure`
ping
  Method: post
  Path: `/V0/nosql/admin#ping`
repair-admin-quorum
  Method: post
  Path: `/V0/nosql/admin#repair-admin-quorum`

Plans
Encapsulates operations, or jobs that modify store state.

plan cancel
  Method: post
  Path: `/V0/nosql/admin/plan#cancel`
plan change-parameters
  Method: post
  Path: `/V0/nosql/admin/plan#change-parameters`
plan change-storagedir
  Method: post
  Path: `/V0/nosql/admin/plan#change-storagedir`
plan change-user
  Method: post
  Path: `/V0/nosql/admin/plan#change-user`
plan create-user
  Method: post
  Path: `/V0/nosql/admin/plan#create-user`
plan deploy-admin
  Method: post
  Path: `/V0/nosql/admin/plan#deploy-admin`
plan deploy-sn
  Method: post
  Path: `/V0/nosql/admin/plan#deploy-sn`
plan deploy-topology
  Method: post
  Path: `/V0/nosql/admin/plan#deploy-topology`
plan deploy-zone
  Method: post
  Path: `/V0/nosql/admin/plan#deploy-zone`
plan deregister-es
  Method: post
  Path: `/V0/nosql/admin/plan#deregister-es`
plan drop-user
  Method: post
  Path: `/V0/nosql/admin/plan#drop-user`
plan enable-requests
  Method: post
  Path: `/V0/nosql/admin/plan#enable-requests`
plan execute
  Method: post
  Path: `/V0/nosql/admin/plan#execute`
plan failover
  Method: post
  Path: `/V0/nosql/admin/plan#failover`
plan grant
  Method: post
  Path: `/V0/nosql/admin/plan#grant`
plan interrupt
  Method: post
  Path: `/V0/nosql/admin/plan#interrupt`
plan migrate-sn
  Method: post
  Path: `/V0/nosql/admin/plan#migrate-sn`
plan network-restore
  Method: post
  Path: `/V0/nosql/admin/plan#network-restore`
plan register-es
  Method: post
  Path: `/V0/nosql/admin/plan#register-es`
plan remove-admin
  Method: post
  Path: `/V0/nosql/admin/plan#remove-admin`
plan remove-sn
  Method: post
  Path: `/V0/nosql/admin/plan#remove-sn`
plan remove-zone
  Method: post
  Path: `/V0/nosql/admin/plan#remove-zone`
plan repair-topology
  Method: post
  Path: `/V0/nosql/admin/plan#repair-topology`
plan revoke
  Method: post
  Path: `/V0/nosql/admin/plan#revoke`
plan start-service
  Method: post
  Path: `/V0/nosql/admin/plan#start-service`
plan stop-service
  Method: post
  Path: `/V0/nosql/admin/plan#stop-service`
plan verify-data
  Method: post
  Path: `/V0/nosql/admin/plan#verify-data`
plan wait
  Method: post
  Path: `/V0/nosql/admin/plan#wait`
show plans
  Method: post
  Path: `/V0/nosql/admin/plans`

Pools
Encapsulates commands that manipulates Storage Node pools, which are used for resource allocations.

pool clone
  Method: post
  Path: `/V0/nosql/admin/pool#clone`
pool create
  Method: post
  Path: `/V0/nosql/admin/pool#create`
pool join
  Method: post
  Path: `/V0/nosql/admin/pool#join`
pool leave
  Method: post
  Path: `/V0/nosql/admin/pool#leave`
pool remove
  Method: post
  Path: `/V0/nosql/admin/pool#remove`
show pools
  Method: post
  Path: `/V0/nosql/admin/pools`

Show
Encapsulates commands that display the state of the store and its components or schemas.

show admins
  Method: post
  Path: `/V0/nosql/admin/admins`
show events
  Method: post
  Path: `/V0/nosql/admin/events`
show indexes
  Method: post
  Path: `/V0/nosql/admin/indexes`
show parameters
  Method: post
  Path: `/V0/nosql/admin/parameters`
show perf
  Method: post
  Path: `/V0/nosql/admin/perf`
show plans
  Method: post
  Path: `/V0/nosql/admin/plans`
show pools
  Method: post
  Path: `/V0/nosql/admin/pools`
show schemas
  Method: post
  Path: `/V0/nosql/admin/schemas`
show snapshots
  Method: post
  Path: `/V0/nosql/admin/snapshots`
show tables
  Method: post
  Path: `/V0/nosql/admin/tables`
show topology
  Method: post
  Path: `/V0/nosql/admin/topology#show`
show upgrade-order
  Method: post
  Path: `/V0/nosql/admin/upgrade-order`
show users
  Method: post
  Path: `/V0/nosql/admin/users`
show versions
  Method: post
  Path: `/V0/nosql/admin/versions`
show zones
  Method: post
  Path: `/V0/nosql/admin/zones`

Snapshots
Encapsulates commands that create and delete snapshots, which are used for backup and restore.

show snapshots
  Method: post
  Path: `/V0/nosql/admin/snapshots`
snapshot create
  Method: post
  Path: `/V0/nosql/admin/snapshot#create`
snapshot remove
  Method: post
  Path: `/V0/nosql/admin/snapshot#remove`

Topologies
Encapsulates commands that manipulate store topologies.

show topology
  Method: post
  Path: `/V0/nosql/admin/topology#show`
topology change-repfactor
  Method: post
  Path: `/V0/nosql/admin/topology#change-repfactor`
topology change-zone-arbiters
  Method: post
  Path: `/V0/nosql/admin/topology#change-zone-arbiters`
topology change-zone-master-affinity
  Method: post
  Path: `/V0/nosql/admin/topology#change-zone-master-affinity`
topology change-zone-type
  Method: post
  Path: `/V0/nosql/admin/topology#change-zone-type`
topology clone
  Method: post
  Path: `/V0/nosql/admin/topology#clone`
topology contract
  Method: post
  Path: `/V0/nosql/admin/topology#contract`
topology create
  Method: post
  Path: `/V0/nosql/admin/topology#create`
topology delete
  Method: post
  Path: `/V0/nosql/admin/topology#delete`
topology list
  Method: post
  Path: `/V0/nosql/admin/topology#list`
topology move-repnode
  Method: post
  Path: `/V0/nosql/admin/topology#move-repnode`
topology preview
  Method: post
  Path: `/V0/nosql/admin/topology#preview`
topology rebalance
  Method: post
  Path: `/V0/nosql/admin/topology#rebalance`
topology redistribute
  Method: post
  Path: `/V0/nosql/admin/topology#redistribute`
topology remove-shard
  Method: post
  Path: `/V0/nosql/admin/topology#remove-shard`
topology validate
  Method: post
  Path: `/V0/nosql/admin/topology#validate`
topology view
  Method: post
  Path: `/V0/nosql/admin/topology#view`

Verification
Encapsulates commands that check various parameters of the store.

verify configuration
  Method: post
  Path: `/V0/nosql/admin/configuration`
verify prerequisite
  Method: post
  Path: `/V0/nosql/admin/prerequisite`
verify upgrade
  Method: post
  Path: `/V0/nosql/admin/upgrade`