Skip to main content

Update Media Agent Properties

Select

SaaS
Customer Managed

This operation updates the properties of a given Media Agent

Path Parameters
  • MediaAgentId string required
Request Body
  • mediaAgentInfo object
  • mediaAgent object
  • mediaAgentId integer
  • mediaAgentProps object
  • markMAOfflineForMaintenance boolean
Responses

OK


Schema
  • error object
  • errorCode integer
PUT /v2/mediaagents/:mediaagentid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
MediaAgentId — path required
Body

{
"mediaAgentInfo": {
"mediaAgent": {
"mediaAgentId": 0
},
"mediaAgentProps": {
"markMAOfflineForMaintenance": true
}
}
}
curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V2/MediaAgents/:MediaAgentId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
"mediaAgentInfo": {
"mediaAgent": {
"mediaAgentId": 0
},
"mediaAgentProps": {
"markMAOfflineForMaintenance": true
}
}
}'