Modify Site License
You can modify a license on a site with the specified UID.
Required Privileges
To perform this task, a user must have the Portal Administrator role assigned.
Request
To modify a license on a site, send the PATCH HTTP request to the URL of the /licensing/sites/{siteUid} resource.
HTTP Request
PATCH https://<hostname>:1280/api/v3/licensing/sites/{siteUid} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
---|---|---|---|---|---|
siteUid | Path | String (uuid) | Yes | — | Site UID |
Body | Body | Array (JSON Patch) | Yes | — | Array of JSON Patch operations according to RFC 6902 |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a modified resource representation based on the SiteLicense schema.
Example
The following request enables automatic update for a site license with UID 120f1c58-76d4-4b5b-993d-9983554c5f6f
Request: PATCH https://localhost:1280/api/v3/licensing/sites/120f1c58-76d4-4b5b-993d-9983554c5f6f
Request Header: Content-Type: application/json Authorization: Bearer <Access-Token>
Request Body: [ { "op": "replace", "value": "true", "path": "/autoUpdateEnabled" } ]
Response Code: 200 OK
Response Body: { "data": { "siteUid": "120f1c58-76d4-4b5b-993d-9983554c5f6f", "autoUpdateEnabled": true, "edition": "Enterprise Plus", "monitoring": false, "packages": [ "backup" ], "company": "Alpha", "email": "a.smith@alpha.com", "contactPerson": "Alan Smith", "expirationDate": "2020-09-29T10:00:00+03:00", "supportExpirationDate": "2020-09-29T10:00:00+03:00", "licenseIds": [ "0475892457" ], "supportIds": [ "00276360" ], "sectionTypes": [ "instance" ], "status": "valid", "cloudConnect": "yes", "units": 3000.0, "usedUnits": 2000.0, "unitType": "instances", "type": "rental" } } |