Remove UID or GID from tracked list

This function removes a user identification number (UID) or group identification number (GID) from the tracked ID list.

SecurityBasicAuth

Request

uid or gid required	integer The user or group ID to remove from the track list. Note: You must include the `uid` parameter, the `gid` parameter, or both. Example: uid or gid=1012
check_exists	integer Default: 1 Whether to prevent removal of user or group IDs currently in use. `1` — Prevent removal. `0` — Do not prevent removal. Enum: 0 1 Example: check_exists=1
check_quota	integer Default: 1 Whether to prevent removal of the user ID if the quota system tracks associated files. `1` — Prevent removal. `0` — Do not prevent removal. Note: This parameter only applies to user IDs and not group IDs. You cannot check filesystems if the quota system does not track them. Enum: 0 1 Example: check_quota=1
protect_system	integer Default: 1 Whether to prevent removal of system user or group IDs. `1` — Prevent removal. `0` — Do not prevent removal. Enum: 0 1 Example: protect_system=1

Responses

200

HTTP Request was successful.

object

get/untrack_acct_id

Request samples

whmapi1 --output=jsonpretty \
  untrack_acct_id \
  uid or gid='1012'

Response samples

application/json

{"metadata": {"command": "untrack_acct_id",
"reason": "OK",
"result": 1,
"version": 1
}
}