Child pages
  • WHM API 1 Functions - untrack_acct_id
Skip to end of metadata
Go to start of metadata

Description


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

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/untrack_acct_id?api.version=1&uid=1012
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/untrack_acct_id?api.version=1&uid=1012
 Command Line
whmapi1 untrack_acct_id uid=1012


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{  
   "metadata":{  
      "command":"untrack_acct_id",
      "result":1,
      "reason":"OK",
      "version":1
   }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>untrack_acct_id</command>
        <reason>OK</reason>
    </metadata>
 </result>          


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
uid or gidinteger

Required

The user identification number or group identification number to remove from the track list.

Note:

You must include the uid parameter, the gid parameter, or both.


A valid positive integer.
1012
protect_systemBoolean

Whether to prevent removal of system user or group IDs.

This parameter defaults to 1.

  • 1 — Prevent removal.
  • 0 — Do not prevent removal.
1
check_existsBoolean

Whether to prevent removal of user or group IDs currently in use.

This parameter defaults to 1.

  • 1 — Prevent removal.
  • 0 — Do not prevent removal.
1
 check_quotaBoolean 

Whether to prevent removal of the user ID if the quota system tracks associated files.

Notes:

  • This parameter only applies to user IDs and not group IDs.
  • You cannot check filesystems if the quota system does not track them.

This parameter defaults to 1.

  • 1 — Prevent removal.
  • 0 — Do not prevent removal.
1

Returns

This function returns only metadata.