Skip to main content
GET
Get a hosted macOS session
  • Credential: an API key of the account that rents the session. Every other account receives 404 macos_session_not_found, never 403. See Who can rent through the API.
  • Line-scoped keys: the list of lines of a line-scoped key is not applied.
  • Events: none.
  • Fields: rented is true on every session that you can read: a released session returns 404. See The session object.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of the hosted macOS session, as returned in id by POST /v1/macos-sessions/rent: mcs_ followed by 25 letters or digits.

Pattern: ^mcs_[0-9A-Za-z]{25}$
Example:

"mcs_7Kd2Nq8Rb4Xw1Ty6Ue9Ao3Ph5"

Response

The hosted macOS session.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

A hosted macOS session that the account rents.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.