Sessions
List sessions
GET/api/v1/sessions
Sessions in the selected organization, visible to every member of it, newest first, with cursor pagination. The organization is chosen by the X-Organization-Id header, or the organization the API key is bound to, otherwise the caller's default organization.
Query parameters
limitintegerMaximum sessions to return (default 100, max 500)
beforestring · date-timeCursor: return sessions created strictly before this RFC3339 timestamp
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
objectstringrequireddataarrayrequiredShow child attributes
idstring · uuidrequiredThe session's own id
titlestringnullableHuman-readable title; may be null
userstringrequiredUser who created this session
devicesarrayrequiredDevice allocations linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredGlobally unique device id. Always present, even when no physical device is attached.
statusstringrequiredDevice lifecycle status. More values will be added.
infoobjectrequiredDescriptive attributes of the device.
Show child attributes
platformstringrequiredtypestringrequirednamestringrequiredosVersionstringrequiredcreatedAtstring · date-timerequiredWhen the device was added to the session
releasedAtstring · date-timenullableWhen the device was released (billing end)
instancesarrayInstances linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredThe instance's own id
statusstringrequiredLifecycle: provisioning -> ready, then released, or failed if provisioning could not complete
osstringrequiredInstance operating system. Only macos is supported today.
imagestringrequiredServer-assigned base image the instance booted from
machineobjectrequiredThe compute backing an instance.
Show child attributes
archstringrequiredCPU architecture. Only arm64 is supported today.
cpuCoresintegerrequiredmemoryMbintegerrequireddiskMbintegerrequiredcreatedAtstring · date-timerequiredWhen the instance was allocated (billing start)
readyAtstring · date-timenullableWhen the instance finished provisioning; null while provisioning
releasedAtstring · date-timenullableWhen the instance was released (billing end); null while active
createdAtstring · date-timerequirednextCursorstringnullableCursor for the next page; absent when there are no more results
Create a session
POST/api/v1/sessions
Creates an empty session container. Attach resources to it separately: use fleet.allocate with sessionId to link a device, or allocate an instance with sessionId.
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequiredThe session's own id
titlestringnullableHuman-readable title; may be null
userstringrequiredUser who created this session
devicesarrayrequiredDevice allocations linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredGlobally unique device id. Always present, even when no physical device is attached.
statusstringrequiredDevice lifecycle status. More values will be added.
infoobjectrequiredDescriptive attributes of the device.
Show child attributes
platformstringrequiredtypestringrequirednamestringrequiredosVersionstringrequiredcreatedAtstring · date-timerequiredWhen the device was added to the session
releasedAtstring · date-timenullableWhen the device was released (billing end)
instancesarrayInstances linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredThe instance's own id
statusstringrequiredLifecycle: provisioning -> ready, then released, or failed if provisioning could not complete
osstringrequiredInstance operating system. Only macos is supported today.
imagestringrequiredServer-assigned base image the instance booted from
machineobjectrequiredThe compute backing an instance.
Show child attributes
archstringrequiredCPU architecture. Only arm64 is supported today.
cpuCoresintegerrequiredmemoryMbintegerrequireddiskMbintegerrequiredcreatedAtstring · date-timerequiredWhen the instance was allocated (billing start)
readyAtstring · date-timenullableWhen the instance finished provisioning; null while provisioning
releasedAtstring · date-timenullableWhen the instance was released (billing end); null while active
createdAtstring · date-timerequiredGet a session
GET/api/v1/sessions/{sessionId}
Returns a session in the selected organization, visible to every member of it. The organization is chosen by the X-Organization-Id header, or the organization the API key is bound to, otherwise the caller's default organization.
Path parameters
sessionIdstring · uuidrequiredSession UUID
Header parameters
X-Organization-IdstringSelects which of the caller's organizations the request acts on. When omitted, the caller's default organization is used.
Returns
idstring · uuidrequiredThe session's own id
titlestringnullableHuman-readable title; may be null
userstringrequiredUser who created this session
devicesarrayrequiredDevice allocations linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredGlobally unique device id. Always present, even when no physical device is attached.
statusstringrequiredDevice lifecycle status. More values will be added.
infoobjectrequiredDescriptive attributes of the device.
Show child attributes
platformstringrequiredtypestringrequirednamestringrequiredosVersionstringrequiredcreatedAtstring · date-timerequiredWhen the device was added to the session
releasedAtstring · date-timenullableWhen the device was released (billing end)
instancesarrayInstances linked to this session, ordered by createdAt ascending
Show child attributes
idstring · uuidrequiredThe instance's own id
statusstringrequiredLifecycle: provisioning -> ready, then released, or failed if provisioning could not complete
osstringrequiredInstance operating system. Only macos is supported today.
imagestringrequiredServer-assigned base image the instance booted from
machineobjectrequiredThe compute backing an instance.
Show child attributes
archstringrequiredCPU architecture. Only arm64 is supported today.
cpuCoresintegerrequiredmemoryMbintegerrequireddiskMbintegerrequiredcreatedAtstring · date-timerequiredWhen the instance was allocated (billing start)
readyAtstring · date-timenullableWhen the instance finished provisioning; null while provisioning
releasedAtstring · date-timenullableWhen the instance was released (billing end); null while active
createdAtstring · date-timerequired