Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

web services APIs

New APIs

addRegion

Registers a region into another region

Parameters

  1. id: Region Id(int) Region Id 
  2. name: Name (String) Name of the Region
  3. endpoint: Region (String) Region end point. e.g. http://10.147.30.11:8080/client 
  4. userapikey: (String)API key of the Admin user
  5. usersecretkey: (String)Secret key of Admin user

Admin user api_key/secret_key are used to make sync API calls to peer regions.

updateRegion

Updates region details

Parameters

  1. id: (int)Region Id
  2. name: (String)Name of the Region
  3. endpoint: (String)Region end point. e.g. https://10.147.30.11:8080/client
  4. userapikey: (String)API key of the Admin user
  5. usersecretkey: (String)Secret key of Admin user

removeRegion

Removes region from current region.

Parameters

  1. id: (int)id of the Region to  be removed

listRegions

list all Regions. Can be filtered by id or name

Parameters

  1. id: list by Region Id
  2. name: (String)list by Region Name

getUser

Admin only API. Get user details by api_key. 

Parameters 

  1. userapikey: (String)Get user details by API key 

...