Loading...

REST API - POST Client Group Quota

This operation sets the quota for a client group.

Request

Syntax

Send the request using either XML or JSON:

  • XML

    POST <webservice>/ClientGroup/{clientGroupId}/Quota HTTP/1.1
    Host: <host name>
    Content-Type: {application/xml|application/json}
    Accept: {application/xml|application/json}
    Authtoken: <authentication token>

    <SetClientGroupQuotaReq>
      <Quota>{quotaValue}</Quota>
    </SetClientGroupQuotaReq>

  • JSON

    POST <webservice>/ClientGroup/{clientGroupId}/Quota HTTP/1.1
    Host: <host name>
    Accept: application/json
    Authtoken: <authentication token>
    Content-Type: application/json

    {"Quota":quotaValue}

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Parameter

Description

Required

clientGroupId

The client computer group ID for the client computer group. If the client computer group ID is not known, use the GET Client Group API to retrieve it.

Yes

Request Headers

Parameter

Description

Host

The host name of the Web Server or Web Console used in the API request.

Content-Type

The media type contained in the request body. Valid values are: application/xml or application/json.

Accept

The format of the response. Valid values are: application/xml or application/json.

Authtoken

The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Request Body

Parameter

Description

Required

quotaValue

The quota value in GB to assign to the client group. For JSON requests, the quota value must be an integer.

Yes

Response

Response Parameters

Parameter

Description

Elements

errorCode

The error code. A successful response is 0.

App_GenericResp

errorMessage

The error message. A successful response is "Client group updated successfully."

App_GenericResp

Examples

Example Request

  • XML

    POST <webservice>/ClientGroup/3/Quota HTTP/1.1
    Host: client.mydomain.com
    Content-Type: application/xml
    Accept: application/xml
    Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
    0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
    8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
    40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
    68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
    3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

    <SetClientGroupQuotaReq>
      <Quota>5</Quota>
    </SetClientGroupQuotaReq>

  • JSON

    POST <webservice>/ClientGroup/3/Quota HTTP/1.1
    Host: client.mydomain.com
    Content-Type: application/xml
    Accept: application/xml
    Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
    0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
    8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
    40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
    68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
    3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

    {"Quota":5}

Example Response

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_GenericResp errorCode="0" errorMessage="Client group updated successfully"/>

Last modified: 4/4/2019 7:32:32 PM