Hosted Solutions
The ONLYOFFICE Hosted Solution exposes a REST API over HTTP for registering portals, listing and suspending them, and reading or changing their pricing plans.
Requests go to the Hosted Solution host, https://{host}:{port}, where the API listens on
port 8092 by default. Every request must carry an Authorization header — see
Authentication for the token format and for examples of
generating one.
Set both the Content-Type and the Accept header to application/json. Responses are JSON;
a failed request returns a non-200 status code and an error code in the body, listed in
Errors.
Portal
| Operation | Method | Path |
|---|---|---|
| List portals | GET | /api/portal/get |
| Register a new portal | POST | /api/portal/register |
| Delete a portal | DELETE | /api/portal/remove |
| Change portal activation status | PUT | /api/portal/status |
| Validate portal name | POST | /api/portal/validateportalname |
Billing
| Operation | Method | Path |
|---|---|---|
| Get tariff | GET | /api/tariff/get |
| Set tariff | PUT | /api/tariff/set |
Objects
| Object | Description |
|---|---|
| Tenant | The portal description. |
| Tariff | The portal pricing plan. |