Add Entitlement Server Configuration

Add Entitlement Server Configuration
Add Entitlement Server Configuration

Add a new Entitlement Server configuration for license management. Validates connectivity and credentials before saving. Automatically triggers vCenter license discovery job upon successful configuration.

Request
URI
POST
https://{server}:9443/api/admin/global/config/entitlementserver
COPY
Request Body
EntitlementserverPostRequestBody of type(s) application/json
Required 
{
    "data": {
        "items": [
            {
                "config": {
                    "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 created 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, invalid credentials, or SSL certificate error

{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}

500

Internal server error - configuration save failed

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Unable to save 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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/admin/global/config/entitlementserver
On This Page
License Management Operations
GET
Get Entitlement Server Configuration
POST
Add Entitlement Server Configuration
PUT
Update Entitlement Server Configuration