Reference
API reference
This section is the reference for the API contract. For step-by-step examples, see the Guides.
Conventions
| Item | Value |
|---|---|
| Base URL | https://{host}:{port} |
| Credential on protected routes | Authorization: Bearer <access_token> |
| Token request body | application/x-www-form-urlencoded |
| Management request body | application/json, sent exactly like this in Content-Type |
| Response body | application/json |
| Token validity | 60 minutes by default; adjustable in session_duration (maximum 720 minutes) |
| Dates in filters | Unix timestamp in milliseconds |
Endpoint catalog
The Riversoft STCP Gemini API is the same API used by the Riversoft Console Portal. Every endpoint below is available for integration. The full contract of each one, with parameters, bodies, responses and examples, is in the OpenAPI specification.
| Group | Base path | Access | Contents |
|---|---|---|---|
| Authentication | /oauth, /disconnect | Public / Bearer | Token (/oauth/token, /oauth/v2/token), 2FA completion (/oauth/v2/token/mfa/{challengeID}) and sign-out. See Authentication. |
| Single Sign-On | /auth/api/v1/sso | Public | SSO sign-in start and SAML 2.0 and OAuth 2.0 callbacks. |
| Information | /info | Public | version, status, report, license and sso/providers. |
| Configuration | /stcpcore/v2 | Bearer | Instances, users, network services, schedules, file types and routings. See Management resources. |
| Administration | /stcpadmin/v2 | Bearer | Operators, groups and permissions, API registration (settings), password policies and error and event codes. |
| Supervision | /stcpadminsvc/v2/supervision/stcpmon | Bearer | Commands to the supervision services and sandbox and keystore files. |
| Maintenance | /stcpadminsvc/v2/supervision/stcpauth | Bearer | Password reset and change, unlock, hash and 2FA of users and operators. |
| Reports | /reports/v2 | Bearer | Events, operator activities, transfers and audit. See Reports. |
In this section
OpenAPI 3.0.3 contract of every Riversoft STCP Gemini API endpoint, with an interactive viewer.
Contract of token issuance, sign-in with 2FA, Single Sign-On and logout.
Contract of the /reports/v2 endpoints: system, users, instance, operators, transfers and audit.
Endpoints for managing instances, users, network services, schedules, file types, routings, operators, groups, API registration, supervision and maintenance.
HTTP status codes returned by the Riversoft STCP Gemini API.