Download OpenAPI specification:Download
This is the spec that defines the API provided by the application to validate authorization for the passed role
Update Feature Settings.
required | Array of objects (FeatureParameter) |
{- "keyval": [
- {
- "key": "InflightTransactionAutoRecovery",
- "value": "enable"
}
]
}
{- "message": "Error",
- "code": 101
}
[- {
- "value": "5",
- "key": "Max Backup File Limit"
}, - {
- "value": "0 0 * *",
- "key": "Backup Schedule"
}, - {
- "value": "5",
- "key": "Max Supportsave File Limit"
}, - {
- "value": "10.10.10.10",
- "key": "Remote Server Ip"
}, - {
- "value": "scp",
- "key": "Remote Transfer Protocol"
}, - {
- "value": "username",
- "key": "Remote Server Username"
}, - {
- "value": "password",
- "key": "Remote Server Password"
}, - {
- "value": "/root/test",
- "key": "Remote Server Directory"
}, - {
- "value": "Enabled",
- "key": "Periodic Device Config Backup"
}
]
Update System Settings.
required | Array of objects (SystemParameter) |
{- "keyval": [
- {
- "value": "5",
- "key": "MaxBackupFiles"
}, - {
- "value": "0 0 * *",
- "key": "BackupSchedule"
}, - {
- "value": "5",
- "key": "MaxSsFiles"
}, - {
- "value": "10.10.10.10",
- "key": "RemoteServerIP"
}, - {
- "value": "scp",
- "key": "RemoteTransferProtocol"
}, - {
- "value": "username",
- "key": "RemoteServerUsername"
}, - {
- "value": "password",
- "key": "RemoteServerPassword"
}, - {
- "value": "/root/test",
- "key": "RemoteServerDirectory"
}, - {
- "value": "Enabled",
- "key": "PeriodicDeviceConfigBackup"
}
]
}
{- "message": "Error",
- "code": 101
}
Reset System Settings.
[- "BackupSchedule",
- "MaxBackupFiles",
- "MaxSsFiles",
- "RemoteServerSettings",
- "PeriodicDeviceConfigBackup"
]
{- "message": "Error",
- "code": 101
}
Get the detailed output of the given execution ID
id required | string Detailed output of the given execution ID |
{- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "id": "id",
- "logs": "logs",
- "URL": "/v1/inventory/switches",
- "status": "Failed, Succeeded"
}
Get the list of all the previous executions
limit required | integer Default: 10 Limit the number of executions that will be sent in the response. Default is 10 |
status | string Default: "all" Filter the executions based on the status(failed/succeeded/all) |
{- "items": [
- {
- "start_time": "2000-01-23T04:56:07.000Z",
- "end_time": "2000-01-23T04:56:07.000Z",
- "id": "id",
- "URL": "/v1/inventory/switches",
- "status": "Completed"
}, - {
- "start_time": "2000-01-22T04:56:07.000Z",
- "end_time": "2000-01-22T04:56:07.000Z",
- "id": "id",
- "URL": "/v1/inventory/switches",
- "status": "Failed"
}
]
}
This API will delete the execution older than specific number of days
days_older_by required | integer Default: 30 Deletes execution entries older than specified number of days |
{- "message": "Error",
- "code": 101
}
Clean up backup and supportsave archives
archive_type required | string Enum: "backup" "supportsave" type of archive that has to be deleted |
name required | string name of archive that has to be deleted |
{- "message": "successfully deleted the archive"
}