Skip to main content

Get Media Agent Details​

Select

SaaS
Customer Managed

Get details of a media agent based on id

Path Parameters
  • mediaAgentId int32 required

    Id of the Media Agent whose details have to be fetched

Query Parameters
  • showInheritedAssociation boolean

    Show inherited security association

Responses

Success

Schema
  • general object
  • id int32

    Id of the media agent.

  • name string

    Name of the media agent.

  • displayName string

    Display name of the media agent.

  • status string

    Possible values: [ONLINE, OFFLINE, MAINTENANCE]

    Current status of the media agent.

  • offlineReason string

    Provides a reason for the media agent being offline. Only given when the media agent is offline.

  • operatingSystem string

    Name of the operating system of the media agent.

  • version string

    The service pack of the media agent.

  • description string

    Description of the media agent.

  • indexCache object
  • path string

    Path where the index cache is maintained.

  • logsCache object
  • enabled boolean

    This tag determines if the logs cache has been enabled or not.

  • path string

    If the logs cache is enabled, this tag gives the path to store the logs cache.

  • control object
  • enabled boolean

    Determines if the media agent is currently enabled or disabled.

  • optimizeForConcurrentLANBackups boolean

    Allows optimization for concurrent LAN backups. If set to true, default value for parallel data transfer operations will be 100. If set to false, default value of parallel data transfer operations will be set to 25.

  • maintenanceMode boolean

    Specifies whether the MediaAgent is available for data protection, data recovery and auxiliary copy operations.

  • ransomwareProtection boolean

    If set to true, ransomware protection against the media agent is enabled. If set to false, ransomware protection against media agent is disabled.

  • parallelDataTransferOperations int32

    Specifies the number of parallel data operations that can take place.

  • security object[]
  • user object
  • id int32
  • name string
  • userGroup object
  • id int32
  • name string
  • externalUserGroup object

    External User Group Entity

  • id int32

    User Group Id

  • name string

    External Group Name

  • providerId int32

    Provider id

  • providerName string

    Provider Name

  • isCreatorAssociation boolean
  • role object
  • id int32
  • name string
  • permissionList object[]
  • permissionId int32
  • permissionName string
  • categoryId int32
  • categoryName string
  • type string

    Possible values: [ALL_CATEGORIES, CATEGORY_ENTITY, PERMISSION_ENTITY]

    Returns the type of association.

  • exclude boolean

    Flag to specify if this is included permission or excluded permission.

GET /v4/mediaagent/:mediaagentid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
mediaAgentId — path required
showInheritedAssociation — query
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/mediaAgent/:mediaAgentId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'