Update Entitlement Server Configuration
Modify Entitlement Server configuration
Updates an existing Entitlement Server configuration identified by UUID. Validates the new configuration before applying changes. Triggers vCenter license discovery job upon successful update.
Request
URI
PUT
https://{server}:9443/api/admin/global/config/entitlementserver/{uuid}
COPY
Path Parameters
string
uuid
Required
The UUID of the Entitlement Server configuration to update
uuid example
d4e5f6a7-b8c9-0123-def1-234567890123Request Body
EntitlementserverPostRequestBody
of type(s)
application/json
Required
{
"data": {
"items": [
{
"config": {
"UUID": "d4e5f6a7-b8c9-0123-def1-234567890123",
"url": "https://entitlement.example.com",
"userName": "entitlement-admin",
"password": "RW50aXRsZW1lbnRQYXNzd29yZA=="
}
}
]
}
}
object
data
Optional
data
Authentication
This operation uses the following authentication methods.
Responses
200
Entitlement Server configuration updated successfully
Returns
EntitlementserverGetResponse200
of type(s)
application/json
{
"data": {
"items": [
{
"section": "entitlementserver",
"config": {
"url": "https://entitlement.example.com",
"userName": "entitlement-admin",
"UUID": "d4e5f6a7-b8c9-0123-def1-234567890123"
}
}
]
}
}
object
data
Required
data
400
Bad request - validation failed or SSL certificate error
{
"isSuccess": false,
"message": "Request schema validation failed",
"httpStatusCode": 400
}
404
Configuration not found
Returns
ErrorResponse
of type(s)
application/json
{
"isSuccess": false,
"message": "Failed modify item: d4e5f6a7-b8c9-0123-def1-234567890123, section: entitlementserver. Config does not exists.",
"httpStatusCode": 404
}
boolean
isSuccess
Required
Indicates if the operation was successful
string
message
Required
Human-readable error message
integer
httpStatusCode
Required
HTTP status code
500
Internal server error - update failed
Returns
ErrorResponse
of type(s)
application/json
{
"isSuccess": false,
"message": "Unable to update Entitlement Server configuration",
"httpStatusCode": 500
}
boolean
isSuccess
Required
Indicates if the operation was successful
string
message
Required
Human-readable error message
integer
httpStatusCode
Required
HTTP status code
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/entitlementserver/{uuid}