Api Token Policy Operations Update

Api Token Policy Operations Update
Update the API token route policy

Change the mode of route families. ADMIN session, or an ADMIN Full-access Bearer API token while tokenCanManagePolicy is on; tokenCanManagePolicy itself can be changed by an ADMIN session only. Audited as API_TOKEN_POLICY_UPDATED.

Request
URI
PUT
https://{api_host}/api/v1/settings/api-token-policy
COPY
Request Body

Families to change; a family that is not listed keeps its mode. tokenCanManagePolicy can be changed by an administrator session only.

UpdateApiTokenPolicyRequest of type(s) application/json
Required  

Show optional properties

{
    "families": {}
}
{
    "families": {
        "groups": "READ",
        "vcenter-connections": "READ_WRITE"
    },
    "tokenCanManagePolicy": true
}
object
families
Required  

Family key to mode. An unknown key or a mode the family does not allow is rejected and nothing is saved.

boolean
tokenCanManagePolicy
Optional

Administrator session only; a token that sends this field is refused

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The policy after the save

Returns ApiTokenPolicyDto of type(s) application/json
{
    "families": [
        {
            "key": "groups",
            "label": "Groups",
            "description": "Security Groups, their Policies and publishing",
            "mode": "READ",
            "defaultMode": "READ_WRITE",
            "allowedModes": [
                "OFF",
                "READ",
                "READ_WRITE"
            ],
            "sensitive": false,
            "routes": [
                "/api/v1/groups/**"
            ]
        }
    ],
    "tokenCanManagePolicy": true,
    "updatedAt": "2026-03-10T09:15:00Z",
    "updatedByUsername": "alice.example"
}
array of object
families
Required  

Every route family with its current mode, in catalog order

boolean
tokenCanManagePolicy
Required  

Whether an Administrator Full-access token may call this API. Only an administrator session can change it.

string As date-time As date-time
updatedAt
Required  

When the policy was last saved; null while the defaults apply

string
updatedByUsername
Required  

Who last saved the policy; null while the defaults apply


400

400 Bad Request error response (INVALID_API_TOKEN_POLICY)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: FORBIDDEN when the signed-in role is not allowed to call this operation; CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ForbiddenWrite of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


500

500 Internal Server Error: INTERNAL_ERROR when the server fails unexpectedly; the message carries no detail

Returns InternalError of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"families":"object"}' https://{api_host}/api/v1/settings/api-token-policy