Skip to main content

Get Servers​

This end point returns the list of servers

Query Parameters
  • showOnlyInfrastructureMachines int32

    Default value: 1

    Returns only infrastructure machines if value is 1 if 0, it returns all servers, default value is 1

Responses

OK

Response Headers
    Schema
    • totalServers int32
    • servers object[]
    • id int32

      Id of server

    • name string

      Name of the client

    • displayName string

      Name to be displayed in UI

    • hostName string

      Hostname of the client

    • agents object[]

      List of agents the server has installed

    • id int32
    • name string
    • configured boolean

      Property to show whether client is in configured state or not

    • version string

      Version of Commvault software server is running. Version is in the format: Release.SPversion.Hotfixpack. eg: 11.22.5

    • OS string

      The operating system, for example, Windows Server 2008 R2 Enterprise.

    • updateState UpdateStatus

      Possible values: [UNKNOWN, UP_TO_DATE, NEEDS_UPDATE, AHEAD_OF_CACHE, NOT_APPLICABLE, HAS_DIAGNOSTIC_UPDATES, OTHER_SOFTWARE, PENDING]

      Enum which specifies the status of update on a server

    • isInfrastructure boolean

      By default, a server is classified as infrastructure if has one of the following packages installed: CommServe, Index Store, Web Server, Content Extractor, Virtual Server Agent (VSA), Web Console, Content Analyzer, Exchange, Cloud Apps

    • isMARoleSet boolean

      Used to determine if MA role is set on the client

    • isMAPackageInstalled boolean

      Used to determine if MA package is instlaled on the client

    • networkReadiness string

      Possible values: [OFFLINE, ONLINE, UNKNOWN, NOT_APPLICABLE]

      Gives the status of the file server.

    • company object
    • id int32
    • name string
    • tags object[]
    • id int32
    • name string
    • value string
    • commcell object
    • name string

      Name of the commcell the entity belongs to.

    • clientRoles object[]
    • id int32
    • name string
    GET /v4/servers

    Authorization

    type: apiKeyname: Authtokenin: header

    Request

    Click Edit to configure Base URL
    https://localhost/webconsole/api
    token
    showOnlyInfrastructureMachines — query
    curl -L -X GET 'https://localhost/webconsole/api/V4/Servers' \
    -H 'Accept: application/json' \
    -H 'Authtoken: <API_KEY_VALUE>'