{
"openapi":"3.0",
"info":{
"description":"REST API for Administering Oracle NoSQL Database",
"version":"2026.05.14",
"title":"REST API for Administering Oracle NoSQL Database",
"x-summary":"REST API for Administering Oracle NoSQL Database"
},
"tags":[
{
"name":"Administration",
"description":"Encapsulates commands that administer, manage, and configure the store."
},
{
"name":"Plans",
"description":"Encapsulates operations, or jobs that modify store state."
},
{
"name":"Pools",
"description":"Encapsulates commands that manipulates Storage Node pools, which are used for resource allocations."
},
{
"name":"Show",
"description":"Encapsulates commands that display the state of the store and its components or schemas."
},
{
"name":"Snapshots",
"description":"Encapsulates commands that create and delete snapshots, which are used for backup and restore."
},
{
"name":"Topologies",
"description":"Encapsulates commands that manipulate store topologies."
},
{
"name":"Verification",
"description":"Encapsulates commands that check various parameters of the store."
}
],
"paths":{
"/V0/nosql/admin#await-consistent":{
"post":{
"tags":[
"Administration"
],
"operationId":"await-consistent",
"summary":"await-consistent",
"description":"Waits for up to the specified number of seconds for the replicas in one or more zones, or in the entire store, to catch up with the masters in their associated shards. Prints information about whether consistency was achieved or, if not, details about which nodes failed to become consistent.",
"requestBody":{
"description":"Admin CLI Command: await-consistent -timeout [-zn | -znname ] [-replica-delay-threshold ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"await-consistency"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"await-consistency",
"arguments":[
{
"timeout":"Timeout value in seconds"
},
{
"zn":"Id of the zone"
},
{
"replicaDelayThreshold":"Allowed replica delay time in milliseconds"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin#await-consistent-post",
"x-filename-id":"v0-nosql-adminawait-consistent-post"
}
},
"/V0/nosql/admin#configure":{
"post":{
"tags":[
"Administration"
],
"operationId":"configure",
"summary":"configure",
"description":"Configures a new store. This call must be made before any other administration can be performed.",
"requestBody":{
"description":"Admin CLI Command: configure -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"configure"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"configure",
"arguments":[
{
"name":"Name of the store"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin#configure-post",
"x-filename-id":"v0-nosql-adminconfigure-post"
}
},
"/V0/nosql/admin#ping":{
"post":{
"tags":[
"Administration"
],
"operationId":"ping",
"summary":"ping",
"description":"Pings the runtime components of a store. Components and Admin services available from the Topology are contacted.",
"requestBody":{
"description":"Admin CLI Command: ping [-shard rgX]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"ping"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"ping",
"arguments":[
{
"shard":"Specify which shard to ping in \"rgX\" format"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin#ping-post",
"x-filename-id":"v0-nosql-adminping-post"
}
},
"/V0/nosql/admin#change-policy":{
"post":{
"tags":[
"Administration"
],
"operationId":"change-policy",
"summary":"change-policy",
"description":"
Modifies store-wide policy parameters to services you have not yet deployed. If you use dryRun, the command returns the parameters you specify without changing them.
The \"params\" argument is an array of objects. Each object has only one field of parameter name/value pairs.
For example: {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}
",
"requestBody":{
"description":"Admin CLI Command: change-policy [-dry-run] -params [name=value]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-policy"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-policy",
"arguments":[
{
"dryRun":"true|false boolean value to specify whether this run will actually execute on server side"
},
{
"params":"Array of objects. Each object has only one field of parameter name/value pairs. For example: {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin#change-policy-post",
"x-filename-id":"v0-nosql-adminchange-policy-post"
}
},
"/V0/nosql/admin#repair-admin-quorum":{
"post":{
"tags":[
"Administration"
],
"operationId":"repair-admin-quorum",
"summary":"repair-admin-quorum",
"description":"Repairs admin quorum by reducing membership of the admin group to the admins in the specified zones or the specific admins listed. This command should be used when attempting to recover from a failure that has resulted in a loss of admin quorum.",
"requestBody":{
"description":"Admin CLI Command: repair-admin-quorum {-zn |-znname |-admin }...",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"repair-admin-quorum"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"repair-admin-quorum",
"arguments":[
{
"zn":"Id of the zone to repair"
},
{
"admin":"Id of the admin to repair"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin#repair-admin-quorum-post",
"x-filename-id":"v0-nosql-adminrepair-admin-quorum-post"
}
},
"/V0/nosql/admin/plan#change-storagedir":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan change-storagedir",
"summary":"plan change-storagedir",
"description":"Adds or removes a storage directory on a Storage Node for use by a Replication Node. When add is specified, the optional storagedirsize flag can be specified to set the size of the directory. The size format is number [unit], where unit can be KB, MG, GB, or TB. The unit is case insensitive and may be separated from the number by a space, -, or _.",
"requestBody":{
"description":"Admin CLI Command: plan change-storagedir -sn -storagedir -add|-remove [-storagedirsize ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-storagedir"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-storagedir",
"arguments":[
{
"sn":"Id of SN to change"
},
{
"storagedir":"Path to storage directory"
},
{
"add":"true|false Whether to add storage directory"
},
{
"remove":"true|false Whether to remove storage directory"
},
{
"storagedirsize":"Size of storage directory"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#change-storagedir-post",
"x-filename-id":"v0-nosql-admin-planchange-storagedir-post"
}
},
"/V0/nosql/admin/plan#change-parameters":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan change-parameters",
"summary":"plan change-parameters",
"description":"
Changes parameters for either the specified service, or for all service instances of the same type that are deployed to the specified zone or all zones.
The security flag changes store-wide security parameters, and should never be used with other flags.
The global flag changes store-wide non-security parameters and should never be used with other flags.
The service flag affects a single component and should not be used with either the zn or znname flag.
One of the all-* flags can be combined with zn or znname to change all instances of the service type deployed to the specified zone, leaving unchanged any instances of the specified type deployed to other zones. If one of the all-* flags is used without also specifying the zone, then the desired parameter change will be applied to all instances of the specified type within the store, regardless of zone. The parameters to change are specified via the params flag and consist of name/value pairs separated by spaces, where any parameter values with embedded spaces must be quoted (for example, name=\"value with spaces\").
Finally, if the dry-run flag is specified, the new parameters are returned without applying the specified change. Use \"show parameters\" to see what parameters can be modified.
",
"requestBody":{
"description":"Admin CLI Command: plan change-parameters -security | -global | -service | -all-rns [-zn | -znname ] | -all-ans [-zn | -znname ] | -all-admins [-zn | -znname ] [-dry-run] -params [name=value]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-parameters"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-parameters",
"arguments":[
{
"security":"true|false Whether this is a security parameter"
},
{
"global":"true|false Whether this is a global parameter"
},
{
"service":"Id of the service to change"
},
{
"allRns":"true|false Whether to change all RNs parameters"
},
{
"zn":"Change parameter in specific zone identified by zone id"
},
{
"znname":"Change parameter in specific zone identified by zone name"
},
{
"allAdmins":"true|false Whether to change parameter for all admins"
},
{
"dryRun":"true|false boolean value to specify whether this run will actually execute on server side"
},
{
"params":"Array of objects, each object has only one field of parameter name/value pair, for exmaple, {\"params\":[{\"name1\":\"value1\"},{\"name1\":\"value1\"},{\"name*\":\"value*\"}*]}"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#change-parameters-post",
"x-filename-id":"v0-nosql-admin-planchange-parameters-post"
}
},
"/V0/nosql/admin/plan#change-user":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan change-user",
"summary":"plan change-user",
"description":"Change a user with the specified name in the store. The retainCurrentPassword argument option causes the current password to be remembered during the setPassword operation as a valid alternate password for configured retention time or until cleared using clearRetainedPassword. If a retained password has already been set for the user, setting retained password again will cause an error to be reported.",
"requestBody":{
"description":"Admin CLI Command: plan change-user -name [-disable | -enable] [-set-password [-password ] [-retain-current-password]] [-clear-retained-password]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-user"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-user",
"arguments":[
{
"name":"Name of the user"
},
{
"disable":"true|false Whether to disable the user"
},
{
"enable":"true|false Whether to enable the user"
},
{
"setPassword":"true|false Whether to set password for the user"
},
{
"password":"User's new password"
},
{
"retainCurrentPassword":"true|false Whether to retain current user password after change"
},
{
"clearRetainedPassword":"true|false Whether to clean the previous reained password"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#change-user-post",
"x-filename-id":"v0-nosql-admin-planchange-user-post"
}
},
"/V0/nosql/admin/plan#create-user":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan create-user",
"summary":"plan create-user",
"description":"Create a user with the specified name in the store. The admin argument indicates that the created user has full administrative privileges.",
"requestBody":{
"description":"Admin CLI Command: plan create-user -name [-admin] [-disable] [-password ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"create-user"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"create-user",
"arguments":[
{
"name":"User name"
},
{
"admin":"true|false Whether to create an admin user"
},
{
"disable":"true|false Whether to create a disabled user"
},
{
"password":"Password of the new user"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#create-user-post",
"x-filename-id":"v0-nosql-admin-plancreate-user-post"
}
},
"/V0/nosql/admin/plan#deploy-admin":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan deploy-admin",
"summary":"plan deploy-admin",
"description":"Deploys an Admin to the specified storage node.",
"requestBody":{
"description":"Admin CLI Command: plan deploy-admin -sn ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"deploy-admin"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"deploy-admin",
"arguments":[
{
"sn":"Id of the SN which is hosting the admin"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#deploy-admin-post",
"x-filename-id":"v0-nosql-admin-plandeploy-admin-post"
}
},
"/V0/nosql/admin/plan#drop-user":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan drop-user",
"summary":"plan drop-user",
"description":"Drop a user with the specified name in the store. A logged-in user may not drop itself.",
"requestBody":{
"description":"Admin CLI Command: plan drop-user -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"drop-user"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"drop-user",
"arguments":[
{
"name":"Name of the user to drop"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#drop-user-post",
"x-filename-id":"v0-nosql-admin-plandrop-user-post"
}
},
"/V0/nosql/admin/plan#remove-admin":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan remove-admin",
"summary":"plan remove-admin",
"description":"
Removes the desired Admin instances; either the single specified instance, or all instances deployed to the specified zone.
If the admin flag is used and there are 3 or fewer Admins running in the store, or if the zn or znname flag is used and the removal of all Admins from the specified zone would result in only one or two Admins in the store, then the desired Admins will be removed only if the force flag is also specified.
Additionally, if the admin flag is used and there is only one Admin in the store, or if the zn or znname flag is used and the removal of all Admins from the specified zone would result in the removal of all Admins from the store, then the desired Admins will not be removed.
",
"requestBody":{
"description":"Admin CLI Command: plan remove-admin -admin | -zn | -znname [-failedSn]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove-admin"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove-admin",
"arguments":[
{
"admin":"Id of the admin to remove"
},
{
"zn":"Remove the admin in the zone by Id"
},
{
"znname":"Remove the admin in the zone by name"
},
{
"failedSn":"true|false Whether the admin is on a failed SN"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#remove-admin-post",
"x-filename-id":"v0-nosql-admin-planremove-admin-post"
}
},
"/V0/nosql/admin/plan#deploy-zone":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan deploy-zone",
"summary":"plan deploy-zone",
"description":"Deploys the specified zone to the store and creates a primary zone if you do not specify a type.",
"requestBody":{
"description":"Admin CLI Command: plan deploy-zone -name -rf [-type {primary | secondary}] [-arbiters | -no-arbiters] [-master-affinity | -no-master-affinity]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"deploy-zone"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"deploy-zone",
"arguments":[
{
"name":"Name of the zone"
},
{
"rf":"Replication factor of the zone"
},
{
"type":"primary|secondary type of zone to deploy"
},
{
"arbiters":"true|false Whether this zone enable arbiters"
},
{
"masterAffinity":"true|false Whether this zone enable master affinity"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#deploy-zone-post",
"x-filename-id":"v0-nosql-admin-plandeploy-zone-post"
}
},
"/V0/nosql/admin/plan#deploy-sn":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan deploy-sn",
"summary":"plan deploy-sn",
"description":"Deploys the storage node at the specified host and port into the specified zone.",
"requestBody":{
"description":"Admin CLI Command: plan deploy-sn -zn | -znname -host -port ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"deploy-sn"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"deploy-sn",
"arguments":[
{
"zn":"Id of the zone to deploy SN"
},
{
"znname":"Name of the zone to deploy SN"
},
{
"host":"Host name of the SN"
},
{
"port":"Port number of the SN"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#deploy-sn-post",
"x-filename-id":"v0-nosql-admin-plandeploy-sn-post"
}
},
"/V0/nosql/admin/plan#deploy-topology":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan deploy-topology",
"summary":"plan deploy-topology",
"description":"Deploys the specified topology to the store. This operation can take a while, depending on the size and state of the store.",
"requestBody":{
"description":"Admin CLI Command: plan deploy-topology -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"deploy-topology"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"deploy-topology",
"arguments":[
{
"name":"Name of the topology to deploy"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#deploy-topology-post",
"x-filename-id":"v0-nosql-admin-plandeploy-topology-post"
}
},
"/V0/nosql/admin/plan#repair-topology":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan repair-topology",
"summary":"plan repair-topology",
"description":"Inspects the store's deployed, current topology for inconsistencies in location metadata that may have arisen from the interruption or cancellation of previous deploy-topology or migrate-sn plans. Where possible, inconsistencies are repaired. This operation can take a while, depending on the size and state of the store.",
"requestBody":{
"description":"Admin CLI Command: plan repair-topology",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"repair-topology"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"repair-topology",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#repair-topology-post",
"x-filename-id":"v0-nosql-admin-planrepair-topology-post"
}
},
"/V0/nosql/admin/plan#execute":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan execute",
"summary":"plan execute",
"description":"
Executes an existing plan that has not yet been executed. The plan must have been previously created using the noexecute flag .
Use the last option to reference the most recently created plan.
",
"requestBody":{
"description":"Admin CLI Command: plan execute -id | -last",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"execute"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"execute",
"arguments":[
{
"id":"Id of the plan to execute"
},
{
"last":"true|false Whether to execute the last plan"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#execute-post",
"x-filename-id":"v0-nosql-admin-planexecute-post"
}
},
"/V0/nosql/admin/plan#failover":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan failover",
"summary":"plan failover",
"description":"Changes zone types to failover to a changed set of primary zones following a failure of primary zones that has resulted in a loss of quorum.",
"requestBody":{
"description":"Admin CLI Command: plan failover {{-zn |-znname } -type {primary|offline-secondary} }...",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"failover"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"failover",
"arguments":[
{
"zn":"Zone id for failover"
},
{
"znname":"Zone name for failover"
},
{
"type":"primary|offline-secondary type of zones for failover"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#failover-post",
"x-filename-id":"v0-nosql-admin-planfailover-post"
}
},
"/V0/nosql/admin/plan#grant":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan grant",
"summary":"plan grant",
"description":"Allows granting roles to users. Currently, the role option accepts only predefined roles in the KVStore.",
"requestBody":{
"description":"Admin CLI Command: plan grant -user [-role ]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"grant"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"grant",
"arguments":[
{
"user":"User name to grant the role"
},
{
"role":"Role name to grant"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#grant-post",
"x-filename-id":"v0-nosql-admin-plangrant-post"
}
},
"/V0/nosql/admin/plan#interrupt":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan interrupt",
"summary":"plan interrupt",
"description":"Interrupts a running plan. An interrupted plan can only be re-executed or canceled. Use last to reference the most recently created plan.",
"requestBody":{
"description":"Admin CLI Command: plan interrupt -id | -last",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"interrupt"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"interrupt",
"arguments":[
{
"id":"Id of the plan to interrupt"
},
{
"last":"true|false Whether to interrupt the last plan"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#interrupt-post",
"x-filename-id":"v0-nosql-admin-planinterrupt-post"
}
},
"/V0/nosql/admin/plan#cancel":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan cancel",
"summary":"plan cancel",
"description":"
Cancels a plan that is not running. A running plan must be interrupted before it can be canceled.
Use last to reference the most recently created plan.
",
"requestBody":{
"description":"Admin CLI Command: plan cancel -id | -last",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"cancel"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"cancel",
"arguments":[
{
"id":"Id of the plan to interrupt"
},
{
"last":"true|false Whether to interrupt the last plan"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#cancel-post",
"x-filename-id":"v0-nosql-admin-plancancel-post"
}
},
"/V0/nosql/admin/plan#migrate-sn":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan migrate-sn",
"summary":"plan migrate-sn",
"description":"Migrates the services from one Storage Node to another. The old node must not be running.",
"requestBody":{
"description":"Admin CLI Command: plan migrate-sn -from -to ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"migrate-sn"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"migrate-sn",
"arguments":[
{
"from":"Id of the SN to migrate from"
},
{
"to":"Id of the SN to migrate to"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#migrate-sn-post",
"x-filename-id":"v0-nosql-admin-planmigrate-sn-post"
}
},
"/V0/nosql/admin/plan#network-restore":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan network-restore",
"summary":"plan network-restore",
"description":"Network restore a RepNode from another one in their replication group.",
"requestBody":{
"description":"Admin CLI Command: plan network-restore -from -to -retain-logs",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"network-restore"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"network-restore",
"arguments":[
{
"from":"Id of the source RN"
},
{
"to":"Id of the target RN"
},
{
"retainLogs":"true|false Whether to retain the original data files during network restore"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#network-restore-post",
"x-filename-id":"v0-nosql-admin-plannetwork-restore-post"
}
},
"/V0/nosql/admin/plan#remove-sn":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan remove-sn",
"summary":"plan remove-sn",
"description":"Removes the specified Storage Node from the topology.",
"requestBody":{
"description":"Admin CLI Command: plan remove-sn -sn ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove-sn"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove-sn",
"arguments":[
{
"sn":"Id of the SN to be removed"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#remove-sn-post",
"x-filename-id":"v0-nosql-admin-planremove-sn-post"
}
},
"/V0/nosql/admin/plan#start-service":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan start-service",
"summary":"plan start-service",
"description":"Starts the specified service(s).",
"requestBody":{
"description":"Admin CLI Command: plan start-service {-service | -all-rns [-zn | -znname ] | -all-ans [-zn | -znname ] | -zn | -znname }",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"start-service"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"start-service",
"arguments":[
{
"service":"Id of the service to start"
},
{
"allRns":"true|false Whether to start all RNs"
},
{
"zn":"Id of the zone to start services"
},
{
"znname":"Name of the zone to start services"
},
{
"allAns":"true|false Whether to start all ANs"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#start-service-post",
"x-filename-id":"v0-nosql-admin-planstart-service-post"
}
},
"/V0/nosql/admin/plan#stop-service":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan stop-service",
"summary":"plan stop-service",
"description":"Stops the specified service(s).",
"requestBody":{
"description":"Admin CLI Command: plan stop-service {-service | -all-rns [-zn | -znname ] | -all-ans [-zn | -znname ] | -zn | -znname }",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"stop-service"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"stop-service",
"arguments":[
{
"service":"Id of the service to stop"
},
{
"allRns":"true|false Whether to stop all RNs"
},
{
"zn":"Id of the zone to stop services"
},
{
"znname":"Name of the zone to stop services"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#stop-service-post",
"x-filename-id":"v0-nosql-admin-planstop-service-post"
}
},
"/V0/nosql/admin/plan#wait":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan wait",
"summary":"plan wait",
"description":"
Waits for the specified plan to complete. If the optional timeout is specified, it waits for the time specified, otherwise waits indefinitely.
Use last to reference the most recently created plan.
",
"requestBody":{
"description":"Admin CLI Command: plan wait -id | -last [-seconds ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"wait"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"wait",
"arguments":[
{
"id":"Id of the plan to wait"
},
{
"last":"true|false Whether to wait for the last plan"
},
{
"seconds":"Timeout in seconds for waiting"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#wait-post",
"x-filename-id":"v0-nosql-admin-planwait-post"
}
},
"/V0/nosql/admin/plan#remove-zone":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan remove-zone",
"summary":"plan remove-zone",
"description":"Removes the specified zone from the store.",
"requestBody":{
"description":"Admin CLI Command: plan remove-zone -zn | -znname ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove-zone"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove-zone",
"arguments":[
{
"zn":"Id of the zone to remove"
},
{
"znname":"Name of the zone to remove"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#remove-zone-post",
"x-filename-id":"v0-nosql-admin-planremove-zone-post"
}
},
"/V0/nosql/admin/plan#enable-requests":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan enable-requests",
"summary":"plan enable-requests",
"description":"Change the type of user requests supported by a set of shards or the entire store.",
"requestBody":{
"description":"Admin CLI Command: plan enable-requests -request-type {all|readonly|none} {-shards | -store}",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"enable-requests"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"enable-requests",
"arguments":[
{
"requestType":"all|readonly|none type of request to enable"
},
{
"shards":"Shard ids in format \"shardId[,shardId]*\""
},
{
"store":"true|false Whether to enable request for the whole store"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#enable-requests-post",
"x-filename-id":"v0-nosql-admin-planenable-requests-post"
}
},
"/V0/nosql/admin/plan#revoke":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan revoke",
"summary":"plan revoke",
"description":"Allows revoking roles to users. Currently, the role option accepts only predefined roles in the KVStore.",
"requestBody":{
"description":"Admin CLI Command: plan revoke -user [-role ]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"revoke"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"revoke",
"arguments":[
{
"user":"Name of the user to revoke role"
},
{
"role":"Name of the role to revoke"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#revoke-post",
"x-filename-id":"v0-nosql-admin-planrevoke-post"
}
},
"/V0/nosql/admin/plan#register-es":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan register-es",
"summary":"plan register-es",
"description":"Registers an Elasticsearch cluster with the store. It is only necessary to register one node of the cluster, as the other nodes in the cluster will be found automatically.",
"requestBody":{
"description":"Admin CLI Command: plan register-es -clustername -host -port ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"register-es"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"register-es",
"arguments":[
{
"clustername":"Elasticsearch cluster name"
},
{
"host":"Host name for Elasticsearch"
},
{
"port":"Port number for Elasticsearch"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#register-es-post",
"x-filename-id":"v0-nosql-admin-planregister-es-post"
}
},
"/V0/nosql/admin/plan#deregister-es":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan deregister-es",
"summary":"plan deregister-es",
"description":"Deregisters an Elasticsearch cluster from the store. This can be done only if all full text indexes are first removed.",
"requestBody":{
"description":"Admin CLI Command: plan deregister-es",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"deregister-es"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"deregister-es",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#deregister-es-post",
"x-filename-id":"v0-nosql-admin-planderegister-es-post"
}
},
"/V0/nosql/admin/plan#verify-data":{
"post":{
"tags":[
"Plans"
],
"operationId":"plan verify-data",
"summary":"plan verify-data",
"description":"
verifyLog verifies the checksum of each data record in the log file of JE. It is enabled by default.
logReadDelay configures the the delay time between file reads and the default value is 100 millisecond.
verifyBtree verifies that the b-tree of database in memory contains the valid reference to each data record in disk. It is enabled by default.
btreeBatchDelay configures the delay time, in milliseconds, between batches (1000 records) and the default value is 10 milliseconds.
verifyBtree can be combined with datarecord and index.
datarecord is disabled by default. If it is enabled, the plan will read and verify data records on disk which are not in the cache. This will take longer and cause more read IO.
index is enabled by default. It runs verification on indexes.
dataRecord needs to be enabled to do a full verification. If datarecord is disabled, the command will only verify the reference from index to primary table, but not the reference from primary table to index.
Users can run the verification on either the specified service using service, or all service instances of the specified type or all types that are deployed to the specified zone or all zones using one of the all-* flags. A all-* flag can be combined with zn or znname to verify data on all instances of the service type deployed to the specified zone. If one of the all-* flags is used without also specifying the zone, then the verification will be run on all instances of the specified type or all types within the store, regardless of zone.
",
"requestBody":{
"description":"Admin CLI Command: plan verify-data [-verify-log [-log-read-delay ]] [-verify-btree [-btree-batch-delay ] [-index ] [-datarecord ]]-service | -all-services [-zn | -znname ] | -all-rns [-zn | -znname ] | -all-admins [-zn | -znname ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"verify-data"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"verify-data",
"arguments":[
{
"verifyLog":"enable|disable Whether to verify logs"
},
{
"logReadDelay":"Log read delay in milliseconds"
},
{
"verifyBtree":"enable|disable Whether to verify btree"
},
{
"btreeBatchDelay":"Btree batch delay in milliseconds"
},
{
"index":"enable|disable Whether to verify index"
},
{
"datarecord":"enable|disable Whether to verify data records"
},
{
"service":"Id of the service to run verification"
},
{
"allServices":"true|false Whether to verify all services"
},
{
"zn":"Id of the zone to verify services in zone"
},
{
"znname":"Name of the zone to verify services in zone"
},
{
"allRns":"true|false Whether to verify all RNs"
},
{
"allAdmins":"true|false Whether to verify all Admins"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plan#verify-data-post",
"x-filename-id":"v0-nosql-admin-planverify-data-post"
}
},
"/V0/nosql/admin/pool#create":{
"post":{
"tags":[
"Pools"
],
"operationId":"pool create",
"summary":"pool create",
"description":"Creates a new Storage Node pool to be used for resource distribution when creating or modifying a store.",
"requestBody":{
"description":"Admin CLI Command: pool create -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"create"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"create",
"arguments":[
{
"name":"Name of the pool to create"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pool#create-post",
"x-filename-id":"v0-nosql-admin-poolcreate-post"
}
},
"/V0/nosql/admin/pool#clone":{
"post":{
"tags":[
"Pools"
],
"operationId":"pool clone",
"summary":"pool clone",
"description":"Clone an existing Storage Node pool to a new Storage Node pool to be used for resource distribution when creating or modifying a store.",
"requestBody":{
"description":"Admin CLI Command: pool clone -name -from ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"clone"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"clone",
"arguments":[
{
"name":"Name of the new pool"
},
{
"from":"Name of the source pool to be cloned"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pool#clone-post",
"x-filename-id":"v0-nosql-admin-poolclone-post"
}
},
"/V0/nosql/admin/pool#remove":{
"post":{
"tags":[
"Pools"
],
"operationId":"pool remove",
"summary":"pool remove",
"description":"Removes a Storage Node pool.",
"requestBody":{
"description":"Admin CLI Command: pool remove -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove",
"arguments":[
{
"name":"Name of the pool to be removed"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pool#remove-post",
"x-filename-id":"v0-nosql-admin-poolremove-post"
}
},
"/V0/nosql/admin/pool#join":{
"post":{
"tags":[
"Pools"
],
"operationId":"pool join",
"summary":"pool join",
"description":"Adds Storage Nodes to an existing Storage Node pool.",
"requestBody":{
"description":"Admin CLI Command: pool join -name [-sn ]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"join"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"join",
"arguments":[
{
"name":"Name of the pool"
},
{
"sn":"SN to join the pool, in the format \"snX\""
}
]
}
}
}
}
},
"responses":{
"200'":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pool#join-post",
"x-filename-id":"v0-nosql-admin-pooljoin-post"
}
},
"/V0/nosql/admin/pool#leave":{
"post":{
"tags":[
"Pools"
],
"operationId":"pool leave",
"summary":"pool leave",
"description":"Remove Storage Nodes from an existing Storage Node pool.",
"requestBody":{
"description":"Admin CLI Command: pool leave -name [-sn ]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"leave"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"leave",
"arguments":[
{
"name":"Name of the pool"
},
{
"sn":"SN to leave the pool, in the format \"snX\""
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pool#leave-post",
"x-filename-id":"v0-nosql-admin-poolleave-post"
}
},
"/V0/nosql/admin/parameters":{
"post":{
"tags":[
"Show"
],
"operationId":"show parameters",
"summary":"show parameters",
"description":"Displays service parameters and state for the specified service. The service may be a RepNode, StorageNode, or Admin service, as identified by any valid string, for example rg1-rn1, sn1, admin2, etc. Use the policy flag to show global policy default parameters. Use the security flag to show global security parameters. Use the global flag to show global component parameters.",
"requestBody":{
"description":"Admin CLI Command: show parameters -policy | -global | -security | -service ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"policy":"true|false Whether to show policy related parameters"
},
{
"global":"true|false Whether to show global parameters"
},
{
"security":"true|false Whether to show security parameters"
},
{
"service":"Name of the service to show the parameters"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-parameters-post",
"x-filename-id":"v0-nosql-admin-parameters-post"
}
},
"/V0/nosql/admin/admins":{
"post":{
"tags":[
"Show"
],
"operationId":"show admins",
"summary":"show admins",
"description":"Displays basic information about deployed Admin services.",
"requestBody":{
"description":"Admin CLI Command: show admins",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-admins-post",
"x-filename-id":"v0-nosql-admin-admins-post"
}
},
"/V0/nosql/admin/schemas":{
"post":{
"tags":[
"Show"
],
"operationId":"show schemas",
"summary":"show schemas",
"description":"Displays schema details of the named schema or a list of schemas registered with the store. The disabled flag displays all schemas, including those which are currently disabled.",
"requestBody":{
"description":"Admin CLI Command: show schemas [-disabled] | [-name ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"disabled":"true|false Whether to show disabled AVRO schemas"
},
{
"name":"Name of standalone AVRO schema to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-schemas-post",
"x-filename-id":"v0-nosql-admin-schemas-post"
}
},
"/V0/nosql/admin/events":{
"post":{
"tags":[
"Show"
],
"operationId":"show events",
"summary":"show events",
"description":"Displays event details or list of store events. The status events indicate changes in service status. Log events correspond to records written to the store log, except that only records logged at SEVERE are displayed; which should be investigated immediately. To view records logged at WARNING or lower, consult the store log file. Performance events are not usually critical but may merit investigation.",
"requestBody":{
"description":"Admin CLI Command: show events [-id ] | [-from ] [-to ] [-type ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"id":"Event id"
},
{
"from":"Start date of event information"
},
{
"to":"End date of event information"
},
{
"type":"stat|log|perf select one type of event to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-events-post",
"x-filename-id":"v0-nosql-admin-events-post"
}
},
"/V0/nosql/admin/plans":{
"post":{
"tags":[
"Show",
"Plans"
],
"operationId":"show plans",
"summary":"show plans",
"description":"
Shows details of the specified plan or list all plans that have been created along with their corresponding plan IDs and status.
last: shows details of the most recent plan
id: shows details of the plan with the given id. If num is also given, list num plans, starting with plan id specified.
num: sets the number of plans to list. Defaults to 10.
from: lists plans after the date specified.
to: lists plans before the date specified.
Combining from with to describes the range between the two dates. Otherwise num applies.
If none of the above arguments are specified, the ten most recent plans are listed.
",
"requestBody":{
"description":"Admin CLI Command: show plans [-last] [-id ] [-from ] [-to ] [-num ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"last":"true|false Whether to show the last plan was executed"
},
{
"id":"Id of the plan to show"
},
{
"from":"Start date of plans to show"
},
{
"to":"End date of plans to show"
},
{
"num":"Maximum number of plans"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-plans-post",
"x-filename-id":"v0-nosql-admin-plans-post"
}
},
"/V0/nosql/admin/pools":{
"post":{
"tags":[
"Show",
"Pools"
],
"operationId":"show pools",
"summary":"show pools",
"description":"Lists the Storage Node pools",
"requestBody":{
"description":"Admin CLI Command: show pools [-name ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"name":"Name of the pool to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-pools-post",
"x-filename-id":"v0-nosql-admin-pools-post"
}
},
"/V0/nosql/admin/perf":{
"post":{
"tags":[
"Show"
],
"operationId":"show perf",
"summary":"show perf",
"description":"Displays recent performance information for each Replication Node.",
"requestBody":{
"description":"Admin CLI Command: show perf",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-perf-post",
"x-filename-id":"v0-nosql-admin-perf-post"
}
},
"/V0/nosql/admin/snapshots":{
"post":{
"tags":[
"Show",
"Snapshots"
],
"operationId":"show snapshots",
"summary":"show snapshots",
"description":"Lists snapshots on the specified Storage Node. If no Storage Node is specified one is chosen from the store.",
"requestBody":{
"description":"Admin CLI Command: show snapshots [-sn ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"sn":"Id of the SN related to snapshots"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-snapshots-post",
"x-filename-id":"v0-nosql-admin-snapshots-post"
}
},
"/V0/nosql/admin/upgrade-order":{
"post":{
"tags":[
"Show"
],
"operationId":"show upgrade-order",
"summary":"show upgrade-order",
"description":"Lists the Storage Nodes which need to be upgraded in an order that prevents disruption to the store's operation.",
"requestBody":{
"description":"Admin CLI Command: show upgrade-order",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-upgrade-order-post",
"x-filename-id":"v0-nosql-admin-upgrade-order-post"
}
},
"/V0/nosql/admin/zones":{
"post":{
"tags":[
"Show"
],
"operationId":"show zones",
"summary":"show zones",
"description":"Lists the names of all zones, or display information about a specific zone. If no zone is specified, it lists the names of all the zones. If a specific zone is specified using either the zone id or the zone name, then additonal information about the zone is displayed.",
"requestBody":{
"description":"Admin CLI Command: show zones [-zn | -znname ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"zn":"Id of the specific zone to show"
},
{
"znname":"Name of the specific zone to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-zones-post",
"x-filename-id":"v0-nosql-admin-zones-post"
}
},
"/V0/nosql/admin/tables":{
"post":{
"tags":[
"Show"
],
"operationId":"show tables",
"summary":"show tables",
"description":"Display the table information. By default, the names of all top-tables and their child tables are listed. Top-level tables are those without parents. The level of child tables can be limited by specifying the level flag. If a specific table is named, its detailed metadata is displayed. The table name is an optionally namespace qualified dot-separated name with the format [ns:]tableName[.childTableName]*. Flag parent is used to show all child tables for the given parent table.",
"requestBody":{
"description":"Admin CLI Command: show tables [-name ] [-parent ] [-level ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"name":"Name of the specific table to show"
},
{
"parent":"Name of the parent table to show all child tables"
},
{
"level":"Specify the the level of the child tables to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-tables-post",
"x-filename-id":"v0-nosql-admin-tables-post"
}
},
"/V0/nosql/admin/indexes":{
"post":{
"tags":[
"Show"
],
"operationId":"show indexes",
"summary":"show indexes",
"description":"
Displays index metadata. By default the indexes metadata of all tables are listed.
If a specific table is named, its indexes metadata are displayed. If a specific index of the table is named, its metadata is displayed.
",
"requestBody":{
"description":"Admin CLI Command: show indexes [-table ] [-name ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"table":"Name of the table to show all indexes"
},
{
"name":"Name of the specific index to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-indexes-post",
"x-filename-id":"v0-nosql-admin-indexes-post"
}
},
"/V0/nosql/admin/users":{
"post":{
"tags":[
"Show"
],
"operationId":"show users",
"summary":"show users",
"description":"Lists the names of all users, or displays information about a specific user. If no user is specified, lists the names of all users. If a user is specified using the name flag, then lists detailed information about the user.",
"requestBody":{
"description":"Admin CLI Command: show users [-name ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"name":"Name of the specific user to show"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-users-post",
"x-filename-id":"v0-nosql-admin-users-post"
}
},
"/V0/nosql/admin/versions":{
"post":{
"tags":[
"Show"
],
"operationId":"show versions",
"summary":"show versions",
"description":"Display client and connected server version information. If you want to get all servers version, use ping instead.",
"requestBody":{
"description":"Admin CLI Command: show versions",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-versions-post",
"x-filename-id":"v0-nosql-admin-versions-post"
}
},
"/V0/nosql/admin/snapshot#create":{
"post":{
"tags":[
"Snapshots"
],
"operationId":"snapshot create",
"summary":"snapshot create",
"description":"Creates a new snapshot using the specified name as the prefix. If the zone id or name is specified then the command applies to all the SNs running in that zone. Snapshot of configurations is also backed up for related SNs in the zones.",
"requestBody":{
"description":"Admin CLI Command: snapshot create -name [-all] [-zn | -znname ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"create"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"create",
"arguments":[
{
"name":"Name of the snapshot to create"
},
{
"zn":"Id of the zone for snapshot operation"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-snapshot#create-post",
"x-filename-id":"v0-nosql-admin-snapshotcreate-post"
}
},
"/V0/nosql/admin/snapshot#remove":{
"post":{
"tags":[
"Snapshots"
],
"operationId":"snapshot remove",
"summary":"snapshot remove",
"description":"Removes the named snapshot. If all is set to true, all snapshots are removed. If the zone id or name is specified then the command applies to all the SNs running in that zone. Snapshot of configurations is also removed for related SNs in the zones.",
"requestBody":{
"description":"Admin CLI Command: snapshot remove {-name | -all} [-zn | -znname ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove",
"arguments":[
{
"name":"Name of the snapshot to remove"
},
{
"all":"true|false boolean value to specify whether to remove all snapshots"
},
{
"zn":"Id of the zone for snapshot operation"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-snapshot#remove-post",
"x-filename-id":"v0-nosql-admin-snapshotremove-post"
}
},
"/V0/nosql/admin/topology#change-repfactor":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology change-repfactor",
"summary":"topology change-repfactor",
"description":"Modifies the topology to change the replication factor of the specified zone to a new value. The replication factor may not be decreased at this time.",
"requestBody":{
"description":"Admin CLI Command: topology change-repfactor -name -pool -zn | -znname -rf ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-repfactor"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-repfactor",
"arguments":[
{
"name":"Name of the topology to change"
},
{
"zn":"Id of the zone to make the change"
},
{
"pool":"Name of SN pool for topology change"
},
{
"rf":"New RF number of the zone"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#change-repfactor-post",
"x-filename-id":"v0-nosql-admin-topologychange-repfactor-post"
}
},
"/V0/nosql/admin/topology#change-zone-type":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology change-zone-type",
"summary":"topology change-zone-type",
"description":"Modifies the topology to change the type of the specified zone to a new type.",
"requestBody":{
"description":"Admin CLI Command: topology change-zone-type -name {-zn | -znname } -type {primary | secondary}",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-zone-type"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-zone-type",
"arguments":[
{
"name":"Name of the topology to change"
},
{
"zn":"Id of the zone to make the change"
},
{
"type":"primary|secondary specify primary or secondary zone type"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#change-zone-type-post",
"x-filename-id":"v0-nosql-admin-topologychange-zone-type-post"
}
},
"/V0/nosql/admin/topology#change-zone-master-affinity":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology change-zone-master-affinity",
"summary":"topology change-zone-master-affinity",
"description":"Modifies the topology to change the master affinity of the specified zone.",
"requestBody":{
"description":"Admin CLI Command: topology change-zone-master-affinity -name {-zn | -znname } {-master-affinity | -no-master-affinity}",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-zone-master-affinity"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-zone-master-affinity",
"arguments":[
{
"name":"Name of the topology to change"
},
{
"zn":"Id of the zone to make the change"
},
{
"masterAffinity":"true|false enable or disable master affinity in the zone"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#change-zone-master-affinity-post",
"x-filename-id":"v0-nosql-admin-topologychange-zone-master-affinity-post"
}
},
"/V0/nosql/admin/topology#change-zone-arbiters":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology change-zone-arbiters",
"summary":"topology change-zone-arbiters",
"description":"Modifies the topology to change the Arbiter Node attribute of the specified zone.",
"requestBody":{
"description":"Admin CLI Command: topology change-zone-arbiters -name {-zn | -znname } {-arbiters | -no-arbiters}",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"change-zone-arbiters"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"change-zone-arbiters",
"arguments":[
{
"name":"Name of the topology to change"
},
{
"zn":"Id of the zone to make the change"
},
{
"arbiters":"true|false enable or disable arbiters in the zone"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#change-zone-arbiters-post",
"x-filename-id":"v0-nosql-admin-topologychange-zone-arbiters-post"
}
},
"/V0/nosql/admin/topology#clone":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology clone",
"summary":"topology clone",
"description":"Clones an existing topology so as to create a new candidate topology to be used for topology change operations.",
"requestBody":{
"description":"Admin CLI Command: topology clone -from -name or topology clone -current -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"clone"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"clone",
"arguments":[
{
"from":"Name of topology to clone from"
},
{
"name":"Name of topology to clone to"
},
{
"current":"true|false whether to clone from current in use topology"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#clone-post",
"x-filename-id":"v0-nosql-admin-topologyclone-post"
}
},
"/V0/nosql/admin/topology#create":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology create",
"summary":"topology create",
"description":"Creates a new topology with the specified number of partitions using the specified storage pool.",
"requestBody":{
"description":"Admin CLI Command: topology create -name -pool -partitions ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"create"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"create",
"arguments":[
{
"name":"Name of the new topology"
},
{
"pool":"Name of SN pool used to create topology"
},
{
"partitions":"Number of partitions for the new topology"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#create-post",
"x-filename-id":"v0-nosql-admin-topologycreate-post"
}
},
"/V0/nosql/admin/topology#delete":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology delete",
"summary":"topology delete",
"description":"Deletes a topology.",
"requestBody":{
"description":"Admin CLI Command: topology delete -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"delete"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"delete",
"arguments":[
{
"name":"Name of the topology to delete"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#delete-post",
"x-filename-id":"v0-nosql-admin-topologydelete-post"
}
},
"/V0/nosql/admin/topology#list":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology list",
"summary":"topology list",
"description":"Lists existing topologies.",
"requestBody":{
"description":"Admin CLI Command: topology list",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"list"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"list",
"arguments":[
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#list-post",
"x-filename-id":"v0-nosql-admin-topologylist-post"
}
},
"/V0/nosql/admin/topology#move-repnode":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology move-repnode",
"summary":"topology move-repnode",
"description":"Modifies the topology to move the specified RepNode to an available storage node chosen by the system.",
"requestBody":{
"description":"Admin CLI Command: topology move-repnode -name -rn ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"move-repnode"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"move-repnode",
"arguments":[
{
"hidden":"true - This command requires hidden flag to be true"
},
{
"name":"Name of topology to change"
},
{
"rn":"Id of the RN to move out of its SN"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#move-repnode-post",
"x-filename-id":"v0-nosql-admin-topologymove-repnode-post"
}
},
"/V0/nosql/admin/topology#preview":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology preview",
"summary":"topology preview",
"description":"Describes the actions that would be taken to transition from the starting topology to the named, target topology. If start is not specified the current topology is used. This command should be used before deploying a new topology.",
"requestBody":{
"description":"Admin CLI Command: topology preview -name [-start ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"preview"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"preview",
"arguments":[
{
"name":"Name of the topology candidate to preview"
},
{
"start":"Name of the starting topology. Change to the target topology to preview the change. If this value is not specified, current topology is used."
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#preview-post",
"x-filename-id":"v0-nosql-admin-topologypreview-post"
}
},
"/V0/nosql/admin/topology#rebalance":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology rebalance",
"summary":"topology rebalance",
"description":"Modifies the named topology to create a balanced topology. If the optional zn flag is used, only Storage Nodes from the specified zone are used for the operation.",
"requestBody":{
"description":"Admin CLI Command: topology rebalance -name -pool [-zn | -znname ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"rebalance"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"rebalance",
"arguments":[
{
"name":"Name of the topology to rebalance"
},
{
"pool":"Name of the SN pool for topology operation"
},
{
"zn":"Id of the zone to limit the rebalance range if specified"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#rebalance-post",
"x-filename-id":"v0-nosql-admin-topologyrebalance-post"
}
},
"/V0/nosql/admin/topology#contract":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology contract",
"summary":"topology contract",
"description":"Modifies the named topology to contract storage nodes.",
"requestBody":{
"description":"Admin CLI Command: topology contract -name -pool ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"contract"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"contract",
"arguments":[
{
"name":"Name of the topology to contract"
},
{
"pool":"Name of the SN pool to select operation candidate"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#contract-post",
"x-filename-id":"v0-nosql-admin-topologycontract-post"
}
},
"/V0/nosql/admin/topology#redistribute":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology redistribute",
"summary":"topology redistribute",
"description":"Modifies the named topology to redistribute resources to more efficiently use those available.",
"requestBody":{
"description":"Admin CLI Command: topology redistribute -name -pool ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"redistribute"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"redistribute",
"arguments":[
{
"name":"Name of the topology to redistribute"
},
{
"pool":"Name of the SN pool to select operation candidate"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#redistribute-post",
"x-filename-id":"v0-nosql-admin-topologyredistribute-post"
}
},
"/V0/nosql/admin/topology#validate":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology validate",
"summary":"topology validate",
"description":"
Validates the specified topology. If no name is provided, the current topology is validated. Validation generates violations and notes.
Violations are issues that can cause problems and should be investigated. Notes are informational and highlight configuration oddities that could be potential issues or may be expected.
",
"requestBody":{
"description":"Admin CLI Command: topology validate [-name ]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"validate"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"validate",
"arguments":[
{
"name":"Name of the topology to validate"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#validate-post",
"x-filename-id":"v0-nosql-admin-topologyvalidate-post"
}
},
"/V0/nosql/admin/topology#view":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology view",
"summary":"topology view",
"description":"Displays details of the specified topology.",
"requestBody":{
"description":"Admin CLI Command: topology view -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"view"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"view",
"arguments":[
{
"name":"Name of the topology to view details"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#view-post",
"x-filename-id":"v0-nosql-admin-topologyview-post"
}
},
"/V0/nosql/admin/topology#remove-shard":{
"post":{
"tags":[
"Topologies"
],
"operationId":"topology remove-shard",
"summary":"topology remove-shard",
"description":"Removes a failed shard from the topology.",
"requestBody":{
"description":"Admin CLI Command: topology remove-shard -failed-shard -name ",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command"
],
"properties":{
"command":{
"type":"string",
"enum":[
"remove-shard"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"remove-shard",
"arguments":[
{
"hidden":"true - This command requires hidden flag to be true"
},
{
"name":"Name of the topology from which the shard must be removed"
},
{
"failedShard":"shard ID of the shard to be removed in rgX format"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#remove-shard-post",
"x-filename-id":"v0-nosql-admin-topologyremove-shard-post"
}
},
"/V0/nosql/admin/topology#show":{
"post":{
"tags":[
"Topologies",
"Show"
],
"operationId":"show topology",
"summary":"show topology",
"description":"Displays the current, deployed topology. By default, it shows the entire topology. The optional flags restrict the display to one or more Zones, RepNodes, StorageNodes and Storename, or to specify service status.",
"requestBody":{
"description":"Admin CLI Command: show topology [-zn] [-rn] [-an] [-sn] [-store] [-status] [-perf]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"show"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"show",
"arguments":[
{
"zn":"true|false Whether to show zone information"
},
{
"rn":"true|false Whether to show RN information"
},
{
"an":"true|false Whether to show AN information"
},
{
"sn":"true|false Whether to show SN information"
},
{
"store":"true|false Whether to show store information"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-topology#show-post",
"x-filename-id":"v0-nosql-admin-topologyshow-post"
}
},
"/V0/nosql/admin/configuration":{
"post":{
"tags":[
"Verification"
],
"operationId":"verify configuration",
"summary":"verify configuration",
"description":"Verifies the store configuration by iterating over components and checking their state against what the Admin database contains. On a large store, this command can be time consuming.",
"requestBody":{
"description":"Admin CLI Command: verify configuration [-silent]",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"verify"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"verify",
"arguments":[
{
"silent":"true|false Whether to run this verification in silent mode. In silent mode, the output does not show any progress message."
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-configuration-post",
"x-filename-id":"v0-nosql-admin-configuration-post"
}
},
"/V0/nosql/admin/upgrade":{
"post":{
"tags":[
"Verification"
],
"operationId":"verify upgrade",
"summary":"verify upgrade",
"description":"Verifies the storage nodes (and their managed components) are at or above the current version. This call may take a while on a large store.",
"requestBody":{
"description":"Admin CLI Command: verify upgrade [-silent] [-sn snX]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"verify"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"verify",
"arguments":[
{
"silent":"true|false Whether to run this verification in silent mode. In silent mode, the output does not show any progress message."
},
{
"sn":"snX - specify which SN to verify"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-upgrade-post",
"x-filename-id":"v0-nosql-admin-upgrade-post"
}
},
"/V0/nosql/admin/prerequisite":{
"post":{
"tags":[
"Verification"
],
"operationId":"verify prerequisite",
"summary":"verify prerequisite",
"description":"Verifies the storage nodes are at or above the prerequisite software version needed to upgrade to the current version. This call may take a while on a large store.",
"requestBody":{
"description":"Admin CLI Command: verify prerequisite [-silent] [-sn snX]*",
"required":true,
"content":{
"application/json":{
"schema":{
"required":[
"command",
"arguments"
],
"properties":{
"command":{
"type":"string",
"enum":[
"verify"
]
},
"arguments":{
"type":"array",
"items":{
"type":"object",
"properties":{
"argumentName":{
"type":"string"
},
"argumentValue":{
"oneOf":[
{
"type":"string"
},
{
"type":"boolean"
}
]
}
}
}
}
},
"example":{
"command":"verify",
"arguments":[
{
"silent":"true|false Whether to run this verification in silent mode. In silent mode, the output does not show any progress message."
},
{
"sn":"snX - specify which SN to verify"
}
]
}
}
}
}
},
"responses":{
"200":{
"description":"Operation ended successfully",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/commonResponse"
}
}
}
}
},
"x-internal-id":"V0-nosql-admin-prerequisite-post",
"x-filename-id":"v0-nosql-admin-prerequisite-post"
}
}
},
"components":{
"schemas":{
"commonResponse":{
"properties":{
"operation":{
"type":"string"
},
"returnCode":{
"type":"string"
},
"description":{
"type":"string"
},
"returnValue":{
"type":"object"
}
},
"example":{
"operation":"operation executed",
"returnCode":"5000 when success, 5100 infers illegal command, 5200 - 5500 infers connection/resource/internal problem at execution",
"description":"error description when returnCode != 5000",
"returnValue":"JSON object with the output returned by the command when returnCode: 5000(success). Otherwise, null"
},
"required":[
"operation",
"returnCode",
"description",
"returnValue"
]
}
}
}
}