Modify Client Properties

This operation updates the properties associated with a client.

More Details

Path Parameters

clientId integer required
The client ID of the client. If the client ID is not known, use the Get Client ID API to retrieve it

application/json

Request Body

clientProperties object
clientProps object
clientSecurity object
associatedUserGroups object[]
userGroupName string
ownerCapabilities object
activityControl object
clientActivityControl object
activityControlOptions object[]
client object
displayName string
clientDescription string
installDirectory string
jobResulsDir object
path string
userAccount object
userName string
osInfo object
Type string
SubType string
Version string
OsDisplayInfo object
ProcessorType string
OSName string
clientEntity object
hostName string
clientName string
commCellName string
TimeZone object
TimeZoneName string
association object
entity object[]
displayName string
clientName string

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

processinginstructioninfo object
attributes object[]
name string
value string
response object[]
errorCode integer
entity object
clientId integer
clientName string
_type_ integer

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 0,
        "clientName": "string",
        "_type_": 0
      }
    }
  ]
}

{
  "processinginstructioninfo": {
    "attributes": [
      {
        "name": "exitval",
        "value": "0"
      }
    ]
  },
  "response": [
    {
      "errorCode": 0,
      "entity": {
        "clientId": 1085,
        "clientName": "vsaqa",
        "_type_": 3
      }
    }
  ]
}

POST /client/:clientid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

token

clientId — path required

Body

Default
Client Properties - Enable Ransomware protection On Media Agent
Client Properties - Updates the Client Owners and Their Permissions
Client Properties - Set or Update Region
Client Properties - Update Display Name
Client Properties - Updates Client Description
Client Properties - Updates Security Association For The Client
Client Properties - Update Client Hostname
Client Properties - Disable Data backup
Client Properties - Disable Data restore
Client Properties - Enable Data restore
Client Additional Settings

{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/client/:clientId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "clientProperties": {
    "clientProps": {
      "clientSecurity": {
        "associatedUserGroups": [
          {
            "userGroupName": "string"
          }
        ],
        "ownerCapabilities": {}
      },
      "activityControl": {},
      "clientActivityControl": {
        "activityControlOptions": [
          {}
        ]
      }
    },
    "client": {
      "displayName": "string",
      "clientDescription": "string",
      "installDirectory": "string",
      "jobResulsDir": {
        "path": "string",
        "userAccount": {
          "userName": "string"
        }
      },
      "osInfo": {
        "Type": "string",
        "SubType": "string",
        "Version": "string",
        "OsDisplayInfo": {
          "ProcessorType": "string",
          "OSName": "string"
        }
      },
      "clientEntity": {
        "hostName": "string",
        "clientName": "string",
        "commCellName": "string"
      },
      "TimeZone": {
        "TimeZoneName": "string"
      }
    }
  },
  "association": {
    "entity": [
      {
        "displayName": "string",
        "clientName": "string"
      }
    ]
  }
}'

Modify Client Properties​

Authorization

Request

Modify Client Properties