Skip to main content

PUT /profiles/{id}

Use this method to modify the properties of a specific profile.

Authentication

Authentication with username and password is required.

Request URL

PUT https://{management_server_IP}/profiles/{id}

where {id} is the unique ID of the server profile that was assigned when the server pattern was deployed. To obtain the server profile ID, use the GET /profiles method.

Query parameters

None

Request body

AttributesRequired / OptionalTypeDescription
profileNameOptionalStringNew server profile name

The profile name must not include these characters & % < >/ “

Ensure that the name you choose is unique. You cannot have two profiles with the same name.

complianceStatusOptionalStringCompliance status. This can be one of the following values.
  • VALID. Server settings are compliant with the profile.

  • INVALID. Server settings are not compliant with the profile. This can be set only if complianceStatus is valid and was set to valid by user.

The following example modifies the name of an existing profile.

{
"profileName": "myNewProfileName",
"complianceStatus": "VALID"
}

Response codes

CodeDescriptionComments
200OKThe request completed successfully.
400Bad RequestA query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. The error message will mention if the status can be set to compliant without redeploying the configuration
403ForbiddenThe orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request.

For XClarity Administrator advanced functions, ensure that you have active licenses for each managed server that supports the advanced functions.

404Not foundA specified resource cannot be found. A descriptive error message is returned in the response body.
500Internal Server ErrorAn internal error occurred. A descriptive error message is returned in the response body.

Response body

None