licensestring
The content of your new .ghl license file.
Upgrade a license
This API upgrades your license and also triggers the configuration process.
Note: The request body for this operation must be submitted as application/x-www-form-urlencoded data. You can submit a parameter value as a string, or you can use a tool such as curl to submit a parameter value as the contents of a text file. For more information, see the curl documentation.
post
{protocol}://{hostname}/api/v3/setup/api/upgrade
Body
application/x-www-form-urlencoded
Body
application/x-www-form-urlencoded
Response
202
Response
202
Response
post/setup/api/upgrade
Body
{}
202
Promote a user to be a site administrator
Note that you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
put
{protocol}://{hostname}/api/v3/users/{username}/site_admin
Path Parameters
usernamestringrequired
Response
204
Response
204
Response
put/users/{username}/site_admin
Path Parameters
204
Demote a site administrator
You can demote any user account except your own.
delete
{protocol}://{hostname}/api/v3/users/{username}/site_admin
Path Parameters
usernamestringrequired
Response
204
Response
204
Response
delete/users/{username}/site_admin
Path Parameters
204
Suspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a 403 response.
You can suspend any user account except your own.
Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see “HTTP verbs.”
put
{protocol}://{hostname}/api/v3/users/{username}/suspended
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
reasonstring
The reason the user is being suspended. This message will be logged in the audit log. If you don’t provide a reason, it will default to “Suspended via API by SITE_ADMINISTRATOR”, where SITE_ADMINISTRATOR is the person who performed the action.
Response
204
Response
204
Response
put/users/{username}/suspended
Path Parameters
Body
{}
204
Unsuspend a user
If your GitHub instance uses LDAP Sync with Active Directory LDAP servers, this API is disabled and will return a 403 response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.
delete
{protocol}://{hostname}/api/v3/users/{username}/suspended
Path Parameters
usernamestringrequired
Body
application/json
Body
application/json
reasonstring
The reason the user is being unsuspended. This message will be logged in the audit log. If you don’t provide a reason, it will default to “Unsuspended via API by SITE_ADMINISTRATOR”, where SITE_ADMINISTRATOR is the person who performed the action.
Response
204
Response
204
Response
delete/users/{username}/suspended
Path Parameters
Body
{}
204