SOCA APIs
SOCA provides an OpenAPI 3.1 interface for most operations such as:
- Applications Management
- Containers Management
- OpenLDAP/Active Directory
- Login Nodes Management
- Target Nodes Management
- Virtual Desktops Management
- HPC Scheduler operations (CRUD jobs or queues)
- ... and more
Authorizations¶
APIs have different level of authorizations:
| Authorization Type | Requirements | Headers | Description |
|---|---|---|---|
@admin_api |
SOCA admin privileges | X-SOCA-USER & X-SOCA-TOKEN |
You must be a SOCA admin to be authorized |
@private_api |
Valid user account | X-SOCA-USER & X-SOCA-TOKEN |
You must have a valid pair of headers |
@retrieve_api_key |
Valid credentials | X-SOCA-USER & X-SOCA-PASSWORD |
Only used to retrieve your API key programmatically |
You can retrieve your API token directly on the web interface via My API Key. Alternatively, you can query the /api/user/api_key endpoint
Documentation¶
Append /api/doc at the end of your SOCA URL to access the documentation:
Documentation provider
Documentation use RapiDoc by default, but you can change it to Swagger if preferred via /api/doc?ui=swagger
| RapiDoc (default) | Swagger |
|---|---|
 |
 |
You can access to the entire spec via /api/api.json (no authentication required)