CloseBackupIndex
July 21, 2025
This API will clear the SessionID from memory.
URL
https://CBS.EXAMPLE.COM/obs/api/json/2/CloseBackupIndex.do
Available Since Version: 10.1
Parameters
Key | Type | Description |
---|---|---|
SysUser | String | Username of an AhsayCBS System User with Admin or API role. |
SysPwd | String | Password matching SysUser. |
LoginName | String | Username of the backup user. |
SessionID | String | Session ID returned from opening the index file. |
Return Values
Key | Type | Description |
---|---|---|
Status | String | "OK" or "Error" |
Message | String | Error message, it only appears if status displays "Error". |
ExptType | String | The type of exception, will only be displayed if the status is "Error". |
Example
INPUT
{
"SysUser":"system",
"SysPwd":"system1",
"LoginName":"user",
"SessionID":"b8758cd0-eeaf-4241-95b9-07044bfd0dda"
}
OUTPUT
{
"Status": "OK"
}