image.store

Available methods

Description

Provides methods to access and modify image stores.

Namespace:

image.store

Method: create

HTTP POST

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

HTTP POST

Description:

Delete an image store

Parameters:

  • string sessionKey

  • string label

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getDetails

HTTP GET

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

HTTP GET

Description:

List available image store types

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct image store type information

    • int "id"

    • string "label"

    • string "name"

Method: listImageStores

HTTP GET

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

HTTP POST

Description:

Set details of an image store

Parameters:

  • string sessionKey

  • string label

  • struct details - image store details

    • string "uri"

    • string "username" - pass empty string to unset credentials

    • string "password"

Returns:

  • int - 1 on success, exception thrown otherwise.