API DocumentationStudio
List Studio requests
Snapshot of pending Studio requests plus short-lived success/failure receipts in the project. Receipts expire after 24 hours. Call this first, then subscribe to the Studio request feed.
Authorization
bearer_auth AuthorizationBearer <token>
Authentication
Create an API token on Profile, or with osctl auth login. Send it in the Authorization header:
Authorization: Bearer os1_...Do not use the Keycloak web-session JWT as an API token. Keep the secret secure and do not share it.
In: header
Query Parameters
project_id*string
ID of the project used to filter results.
Response Body
application/json
application/json
text/pain
application/json
application/json
curl -X GET "https://example.com/v1/studio/requests?project_id=default"{ "requests": [ { "id": "0196f0c0-7a3e-7b33-99a7-85d78d7a3320", "node_id": "pending-computer-1", "action": "computer.create", "status": "pending", "preview": {}, "resource_id": "string", "error": "string", "status_code": 409, "created_at": "2019-08-24T14:15:22Z", "completed_at": "2019-08-24T14:15:22Z" } ], "pending_count": 2}{ "errors": [ { "message": "'vcpus' field must be an integer", "field": "resource_id" } ]}"Access denied"{ "errors": [ { "message": "User not initialized. Send POST /v1/init, then retry the request." } ]}{ "errors": [ { "message": "VM with ID 23 not found" } ]}