uappsso — Reseller API
Create a UAPP login link through the Reseller API, with request fields, response details, errors and cURL/Python/PHP examples.
/api/v1/uappsso/Also accepts GETGenerates a signed quick-login URL for an existing, unsuspended hosting user. The API response contains a URL, not an HTTP redirect. The link targets the server hostname on UAPP HTTPS port 3333. The current token generator sets a 30-minute expiry. Treat the full URL as a login credential: deliver it only to the intended user, do not log it or put it in analytics, and do not follow it automatically from a backend test. The route is uappsso; the older quickloginurl name in source comments is not a declared route.
Request
The selected account must be in the authenticated reseller accounts list and have a hosting-user file. Other resellers’ accounts are rejected with HTTP 400 and JSON status 400; this is an ownership check, not an authentication failure.
This handler rejects changes to a suspended target account with HTTP 400 and JSON status 400.
| Property | Value |
|---|---|
| Methods | GET, POST |
| Versioned path | /api/v1/uappsso/ |
| Default path | /api/uappsso/ |
| Authentication | Reseller API credentials. |
| Header | Required value |
|---|---|
X-RESELLER | The reseller account owning these API credentials. |
X-API-USER | Your Reseller API username. |
X-API-PASSWORD | Its API password. |
Parameters
| Field | Required | Type and behavior |
|---|---|---|
user | Yes | String. Existing hosting username; required account state is described above. |
POST reads the JSON/form body; GET reads query parameters. The examples use form-encoded POST. Although GET is supported, use POST for account changes and login-link generation so action fields are not placed in URLs. Authentication remains in the two headers. Undeclared fields are not additional API options.
Replace server.example.com, examplereseller, billing_api and YOUR_API_PASSWORD in each standalone example. Replace operation sample values with your actual target and an existing package where required. Python needs Requests; PHP needs the cURL extension. These examples make real calls when run.
Success response
HTTP 200. Illustrative values; account records and server values vary. Stored account examples show only selected fields.
{
"data": {
"url": "https://server.example.com:3333/quick/EXAMPLE_TOKEN"
},
"info": "Hosting account quick login url of exampleuser",
"status": 200
}| Field | Type | Meaning |
|---|---|---|
status | integer | 200 on the documented success branch. |
info | string | Operation description. |
data | object | Operation data described below. |
data.url | string | Signed quick-login URL; its token is a credential. |
Errors and demo mode
| Condition | Actual HTTP status | Response behavior |
|---|---|---|
| Missing credentials with no other authenticated identity | 403 | detail: Authentication credentials were not provided. |
| Rejected password or source IP | 403 | detail: Invalid API credentials |
| Demo server | 400 | error: Demo server; info: Api Operations not available in demo server; JSON status: 403. |
| Invalid/missing operation fields or invalid target state | 400 | Field errors in error; JSON status: 400. |
| Backend reports failure | 400 | Operation error in error; JSON status: 500. |
| Unsupported method | 405 after authentication | Method-not-allowed response. |
Validation failure description: Unable to retrieve quick login url. The data is invalid.
Check both the HTTP status and JSON shape. Authentication failures do not use the operation envelope. Unexpected uncaught server errors are not guaranteed to return the documented JSON shape. Do not automatically retry account creation, password changes, deletions or SSO generation after a timeout: confirm the actual state first.
See Reseller API authentication and connection troubleshooting.