BSN.cloud API Reference#
Complete reference for the BSN.cloud REST API.
Base URLs#
| Service | URL |
|---|---|
| Main API | https://api.bsn.cloud/2022/06/REST |
| Auth | https://auth.bsn.cloud |
| B-Deploy | https://provision.bsn.cloud |
| Remote DWS | https://ws.bsn.cloud |
Authentication#
Get Access Token#
POST
https://auth.bsn.cloud/realms/bsncloud/protocol/openid-connect/token
Basic AuthRequest:
Content-Type: application/x-www-form-urlencoded
Authorization: Basic {base64(clientId:clientSecret)}
grant_type=client_credentialsResponse:
| |
Set Network Context#
PUT
/Self/Session/Network
Bearer Token | |
Devices#
List Devices#
GET
/Devices
Bearer TokenQuery Parameters:
$filter- OData filter expression$orderby- Sort field$top- Max results$skip- Offset for pagination
Get Device#
GET
/Devices/{id}
Bearer TokenReboot Device#
POST
/Devices/{id}/Reboot
Bearer TokenTake Screenshot#
POST
/Devices/{id}/Snapshot
Bearer TokenContent#
List Content#
GET
/Content
Bearer TokenUpload Content#
POST
/Content
Bearer Token | |
Delete Content#
DELETE
/Content/{id}
Bearer TokenPresentations#
List Presentations#
GET
/Presentations
Bearer TokenPublish Presentation#
POST
/Presentations/{id}/Publish
Bearer TokenUsers#
List Users#
GET
/Users
Bearer TokenGet Current User#
GET
/Self
Bearer TokenResponse Codes#
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created |
| 204 | No Content (success) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Rate Limited |
| 500 | Server Error |
Rate Limits#
- 100 requests per minute per token
- 1000 requests per hour per application
For detailed API documentation, see BSN.cloud APIs.