List all System Managers

GET https://{{axpAPIDomain}}/api/admin/voice/v1/accounts/:accountId/system-managers?filter=name=SMGR123&orderBy=name

This API requires the Account Administrator role.

Returns the list of all available System Managers by account Id

Request Params

KeyDatatypeRequiredDescription
filterstringSpecifies details of a row filter.

The possible fields that can be filtered on are:

  • name

The allowed format:

  • Begins with the column name to be filtered, followed by a colon, then:
    • Either an exact string to match, or
    • A string expression including the * wildcard character
      • :{PREFIX}* will be used to find out word start with.
      • :*{POSTFIX} will be used to find out word end with
      • : will be used to match exact word
  • Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string) | | orderBy | string | | Field name on which ordering needs to be performed. The default order is ascending.

The possible fields that can be ordered on are:

  • name

Field Names are case-senstive (should be written as it is in description).

To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending". |

HEADERS

KeyDatatypeRequiredDescription
appkeystring
Acceptstring

RESPONSES

status: OK

{"resources":[{"id":"7700d655-5807-4738-a868-712740a18199","name":"SMGR123","description":"Description of the System Manager","primaryHostname":"dc1-smgr96.avayacloud.stage","username":"dummyUser","password":"dummypassword","enrollmentPassword":"testpassword","secondaryHostname":"dc2-smgr97.avayacloud.stage","activeSystemManager":"PRIMARY","useForCerts":true,"status":"IN_PROGRESS"},{"id":"8b2ae74d-61e5-48df-8b32-81a7bc726495","name":"SmgrTest","description":"Description of the System Manager","primaryHostname":"dc2-smgr105.avayacloud.stage","username":"dummyUser","password":"dummypassword","enrollmentPassword":"testpassword","secondaryHostname":"dc1-smgr98.avayacloud.stage","activeSystemManager":"PRIMARY","useForCerts":true,"status":"SUCCESS"}]}