image.store
Description
Provides methods to access and modify image stores.
Namespace:
image.store
Method: create
Description:
Create a new Image Store
Parameters:
-
string sessionKey
-
string label
-
string uri
-
string storeType
-
struct - credentials optional
-
string "username"
-
string "password"
-
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: delete
Description:
Delete an Image Store
Parameters:
-
string sessionKey
-
string label
Returns:
-
int - 1 on success, exception thrown otherwise.
Method: getDetails
Description:
Get details of an Image Store
Parameters:
-
string sessionKey
-
string label
Returns:
-
* struct - Image Store information
-
string "label"
-
string "uri"
-
string "storetype"
-
boolean "hasCredentials"
-
string "username"
-
Method: listImageStoreTypes
Description:
List available Image Store Types
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct - Image Store Type information
-
int "id"
-
string "label"
-
string "name"
-
Method: listImageStores
Description:
List available Image Stores
Parameters:
-
string sessionKey
Returns:
-
array :
-
struct - Image Store information
-
string "label"
-
string "uri"
-
string "storetype"
-
boolean "hasCredentials"
-
string "username"
-
Method: setDetails
Description:
Set details of an Image Store
Parameters:
-
string sessionKey
-
string label
-
struct - image store details
-
string "uri"
-
string "username" - pass empty string to unset credentials
-
string "password"
-
Returns:
-
int - 1 on success, exception thrown otherwise.