Skip to main content

Create a Media Agent​

Select

SaaS
Customer Managed

To install MediaAgent package on a server

Request Body

Server information where you want to install MediaAgent package.

  • hostNames string[] required

    Possible values: >= 1

    Host names where MediaAgent package is required to be installed

  • username string required

    Username to access hostnames

  • password string

    password should be in base64 encoded string. password is optional only if SSHKeyFilePassphrase is specified

  • OSType string

    Possible values: [WINDOWS, UNIX]

    Default value: WINDOWS

  • installLocation string

    Holds install path according to the chosen OSType

  • rebootIfRequired boolean

    Default value: false

  • SSHKeyPath string

    Applicable only for Unix OSType. Path provided should be valid on the CommServ Client

  • SSHKeyFilePassphrase string

    Applicable only for Unix OSType and should be in base64 encoded string

Responses

OK

Schema
  • jobId string
POST /v4/mediaagent

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "hostNames": [

    "string"

  ],

  "username": "string",

  "password": "string",

  "OSType": "WINDOWS",

  "installLocation": "string",

  "rebootIfRequired": false,

  "SSHKeyPath": "string",

  "SSHKeyFilePassphrase": "string"

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/mediaAgent' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "hostNames": [
    "string"
  ],
  "username": "string",
  "password": "string",
  "OSType": "WINDOWS",
  "installLocation": "string",
  "rebootIfRequired": false,
  "SSHKeyPath": "string",
  "SSHKeyFilePassphrase": "string"
}'