The Archive · Desktop reference · Local API

Terminals

The real terminals of a session. 3 operations of the TALOS Desktop local API.

Reference for TALOS Desktop 0.1.25 generated from the source of the release · released

The real terminals of a session. Paths are relative to /api/v1.

The terminals open in a session.

Path

sessionId
The session.

Answers The JSON envelope.

Errors2
CodeStatusMeaning
NOT_FOUND 404 Nothing answers at this address, or the resource it names does not exist.
QUERY_INVALID 400 The request is not valid: a query parameter or a body field is missing, unknown or malformed.

Any operation can also answer the common errors.

Open a terminal in the session’s folder (the body must be empty).

Path

sessionId
The session.

Body

None: the body is empty.

Answers The JSON envelope.

Errors2
CodeStatusMeaning
QUERY_INVALID 400 The request is not valid: a query parameter or a body field is missing, unknown or malformed.
TERMINAL_STORE_UNAVAILABLE 503 Terminals are not available on this server.

Any operation can also answer the common errors.

POST /sessions/{sessionId}/terminals/{terminalId}/close

Section titled “POST /sessions/{sessionId}/terminals/{terminalId}/close”

Close a terminal (the body must be empty).

Path

sessionId
The session.
terminalId
The terminal.

Body

None: the body is empty.

Answers The JSON envelope.

Errors2
CodeStatusMeaning
QUERY_INVALID 400 The request is not valid: a query parameter or a body field is missing, unknown or malformed.
TERMINAL_STORE_UNAVAILABLE 503 Terminals are not available on this server.

Any operation can also answer the common errors.

Type to search the guides.