Shell
Open a shell in a running instance from the browser, and list, download and upload its files. Administrators and owners only. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/services/{id}/shell/availabilityAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Service id.
Query Parameters
Environment id.
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/services/string/shell/availability?environmentId=string"{ "$schema": "https://example.com/AvailabilityOutputBody.json", "allowed": true, "canUpload": true, "code": "ok", "idleTimeoutSeconds": 0, "maxFileBytes": 0, "maxSessionSeconds": 0, "message": "string"}/api/v1/services/{id}/shell/downloadAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Service id.
Query Parameters
Environment id.
Instance name.
1 <= lengthAbsolute path of a file, or of a directory with archive=true.
1 <= lengthDownload a directory as a tar archive.
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/services/string/shell/download?environmentId=string""string"/api/v1/services/{id}/shell/filesAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Service id.
Query Parameters
Environment id.
Instance name.
1 <= lengthAbsolute directory path inside the container.
1 <= lengthResponse Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/services/string/shell/files?environmentId=string"{ "$schema": "https://example.com/ListOutputBody.json", "entries": [ { "kind": "file", "modTime": "string", "mode": "string", "name": "string", "size": 0, "target": "string" } ], "path": "string", "truncated": true}/api/v1/services/{id}/shell/sessionsAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Service id.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/services/string/shell/sessions" \ -H "Content-Type: application/json" \ -d '{ "cols": 1, "environmentId": "string", "pod": "string", "rows": 1 }'{ "$schema": "https://example.com/OpenOutputBody.json", "expiresAt": "2019-08-24T14:15:22Z", "idleTimeoutSeconds": 0, "maxSessionSeconds": 0, "sessionId": "string", "streamPath": "string", "ticket": "string"}/api/v1/services/{id}/shell/uploadAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Service id.
Query Parameters
Environment id.
Instance name.
1 <= lengthAbsolute directory inside the container.
1 <= lengthFile name to create in the directory; a file of that name is replaced.
1 <= length <= 255Request Body
application/octet-stream
TypeScript Definitions
Use the request body type in TypeScript.
binaryResponse Body
application/problem+json
curl -X POST "https://example.com/api/v1/services/string/shell/upload?environmentId=string" \ -H "Content-Type: application/octet-stream" \ -d 'string'Observability
Logs, metrics, traffic and runtime state of services and environments. Each operation lists its method and path, parameters, request body, responses and an example call.
Events
A live stream of hints about what changed in the active organization. Each operation lists its method and path, parameters, request body, responses and an example call.