Install Client with Media Agent Package

Install Client with Media Agent Package

application/json

Request Body required

• clientAuthForJob object

  password string

  userName string
• createPseudoClientRequest object

  clientInfo object

  clientType int32

  registerClient boolean
• entities object[]

  clientId int32

  clientName string

  hostName string
• packages object[]

  packageId int32

  packageName string
• rebootClient boolean

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Example 1

---

Schema

• jobId integer
• taskId integer
• response object

  errorCode integer

{
  "jobId": 0,
  "taskId": 0,
  "response": {
    "errorCode": 0
  }
}

{
  "jobId": 61,
  "taskId": 173,
  "response": {
    "errorCode": 0
  }
}

POST /installclient    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Content-Type

application/jsonapplication/xml

Body required

• Default
• Example

---

{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/InstallClient' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientAuthForJob": {
    "password": "{{Base64encodedpassword}}",
    "userName": "{{userName}}"
  },
  "createPseudoClientRequest": {
    "clientInfo": {
      "clientType": 0
    },
    "registerClient": true
  },
  "entities": [
    {
      "clientId": 0,
      "clientName": "{{clientName}}",
      "hostName": "{{hostName}}"
    }
  ],
  "packages": [
    {
      "packageId": 702,
      "packageName": "File System"
    },
    {
      "packageId": 51,
      "packageName": "MediaAgent"
    }
  ],
  "rebootClient": false
}'