BackupCommand - BackupCommand Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/{CommandId}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: backup-command
Needs description.
FieldDescription
CommandIdNeeds description.
command-nameNeeds description.
dest-dirNeeds description.
dest-fileNeeds description.
done-fileNeeds description.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
optionsNeeds description.
part-rangeNeeds description.
src-dirNeeds description.
src-fileNeeds description.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"backup-command",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42"
   },
   "command-name":"Wildebeest",
   "dest-file":"Wildebeest",
   "src-dir":"Wildebeest",
   "src-file":"Wildebeest",
   "part-range":"Wildebeest",
   "done-file":"Wildebeest",
   "CommandId":42,
   "dest-dir":"Wildebeest",
   "options":"Wildebeest"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: backup-command
Needs description.
FieldRequiredDescription
CommandIdtrueNeeds description.
command-namefalseNeeds description.
dest-dirfalseNeeds description.
dest-filefalseNeeds description.
done-filefalseNeeds description.
optionsfalseNeeds description.
part-rangefalseNeeds description.
src-dirfalseNeeds description.
src-filefalseNeeds description.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42
{
   "command-name":"Wildebeest",
   "dest-file":"Wildebeest",
   "src-dir":"Wildebeest",
   "src-file":"Wildebeest",
   "part-range":"Wildebeest",
   "done-file":"Wildebeest",
   "CommandId":42,
   "dest-dir":"Wildebeest",
   "options":"Wildebeest"
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/backup-command/42