Update server node profile

This function activates a server profile.

Note:

  • If a server profile enables a service, the system will also enable service monitoring. To disable a service's monitoring, use WHM's Service Manager interface (WHM >> Home >> Service Configuration >> Service Manager).
  • For a list of the server's available profiles, use the get_available_profiles function.
Authorizations:
query Parameters
code
required
string

The code value of the server profile.

  • STANDARD — The Standard profile.
  • DATABASENODE — The Database profile.
  • MAILNODE — The Mail profile.
  • DNSNODE — The DNS profile.
Enum: "STANDARD" "DATABASENODE" "MAILNODE" "DNSNODE"
Example: code=MAILNODE
object

The optional roles to enable or disable with the profile, in JSON format. You must URI-encode this value.

Note:

  • As an example, if you wished to enable SpamFilter and disable DNS, the JSON object would be:

    { "SpamFilter": 1, "DNS": 0 }.

  • This parameter does not enable optional roles for profiles that do not possess any optional roles.

  • If you do not pass this parameter, the system disables a profile's optional roles, if any exist.

Example: optional={"DNS":0,"SpamFilter":1}

Responses

Response Schema: application/json
object
object

Request samples

whmapi1 --output=jsonpretty \
  start_profile_activation \
  code='MAILNODE'

Response samples

Content type
application/json
{
  • "data": {
    • "log_id": "17053.10418168.1533478604"
    },
  • "metadata": {
    • "command": "start_profile_activation",
    • "reason": "OK",
    • "result": 1,
    • "version": 1
    }
}