Devices API

Manage authorized devices for CLI and desktop applications.

Endpoints#

MethodEndpointDescription
GET/devicesList authorized devices
GET/devices/:idGet device details
DELETE/devices/:idRevoke device authorization
POST/devices/authorizeStart device authorization
POST/devices/tokenExchange device code for token

Device Object#

Loading code block...

List Devices#

Loading code block...

Query Parameters#

ParameterTypeDescription
typestringFilter by type: cli, desktop, other
activebooleanOnly active devices (last 30 days)

Example Request#

Loading code block...

Response#

Loading code block...

Get Device#

Loading code block...

Example Request#

Loading code block...

Response#

Loading code block...

Revoke Device#

Loading code block...

Example Request#

Loading code block...

Response#

Loading code block...

Note: Revoking a device invalidates all tokens issued to that device.

Start Device Authorization#

Loading code block...

This initiates the device authorization flow for CLI tools.

Request Body#

FieldTypeRequiredDescription
clientIdstringYesApplication identifier
scopestringNoRequested permission scopes
deviceInfoobjectNoDevice metadata

Example Request#

Loading code block...

Response#

Loading code block...

Exchange Device Code#

Loading code block...

Poll this endpoint to exchange the device code for an access token.

Request Body#

FieldTypeRequiredDescription
clientIdstringYesApplication identifier
deviceCodestringYesDevice code from authorize
grantTypestringYesMust be urn:ietf:params:oauth:grant-type:device_code

Example Request#

Loading code block...

Pending Response#

Loading code block...

Success Response#

Loading code block...

Rename Device#

Loading code block...

Request Body#

Loading code block...

Response#

Returns the updated device object.

Device Limits by Plan#

PlanMax Devices
Free2
Pro5
Team20 per user
EnterpriseUnlimited

Activity Tracking#

Each device tracks:

  • Sessions: Number of CLI sessions
  • Commands: Most used commands
  • Projects: Projects accessed
  • Location: Approximate location from IP

View activity:

Loading code block...
Loading code block...

Security#

Suspicious Activity Detection#

Bootspring monitors for:

  • Logins from new locations
  • Multiple failed authentication attempts
  • Unusual access patterns

Automatic Revocation#

Devices may be automatically revoked for:

  • 90 days of inactivity
  • Security policy violations
  • Account suspension

Errors#

CodeDescription
device_not_foundDevice doesn't exist
device_limit_exceededMaximum devices reached
authorization_pendingUser hasn't authorized yet
expired_tokenDevice code expired
access_deniedUser denied authorization
slow_downPolling too frequently