Child pages
  • WHM API 1 Functions - untrack_acct_id

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description


Excerpt

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


Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/untrack_acct_id?api.version=1&uid=1012



Expand
titleXML API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/untrack_acct_id?api.version=1&uid=1012



Expand
titleCommand Line


Code Block
whmapi1 untrack_acct_id uid=1012

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "command":"untrack_acct_id",
      "result":1,
      "reason":"OK",
      "version":1
   }
}



Expand
titleOutput (XML)


Code Block
languagetext
linenumberstrue
<result>
    <metadata>
        <version>1</version>
        <result>1</result>
        <command>untrack_acct_id</command>
        <reason>OK</reason>
    </metadata>
 </result>          


Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


Parameters

ParameterTypeDescriptionPossible valuesExample
uid or gidinteger

Required

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

Note
titleNote:

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.

Note
titleNotes:
  • 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.