Bansafe
Get number safe mode
Returns the project ceiling, this number’s override, the policy in force, and what the number last reported it is running. mismatch is true when the two differ. entitled reports whether the plan includes BanSafe Lite, which Safe Mode is part of, and entitlementReason gives the reason a raise would be refused.
Requires sessions:read. Project tokens only access resources in their own project.
GET
/
platform
/
sessions
/
{sessionId}
/
safe-mode
Get number safe mode
curl --request GET \
--url https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}false{
"data": {
"session": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": {
"presence": "dark",
"typing": "off",
"reads": "off",
"pacing": "off",
"onlineStart": 11,
"onlineEnd": 11
},
"override": {
"presence": "inherit",
"typing": "inherit",
"reads": "inherit",
"pacing": "inherit"
},
"effective": {
"presence": "dark",
"typing": "off",
"reads": "off",
"pacing": "off",
"onlineStart": 11,
"onlineEnd": 11
},
"applied": {
"observedAt": "2023-11-07T05:31:56Z",
"presence": "<string>",
"typing": "<string>",
"reads": "<string>",
"pacing": "<string>"
},
"mismatch": true,
"entitled": true,
"entitlementReason": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}Authorizations
Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.
Path Parameters
Database session UUID or stable session slug.
Required string length:
1 - 64Response
Success
Structured data carried by this object.
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Get number safe mode
curl --request GET \
--url https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.polymorfa.com/platform/sessions/{sessionId}/safe-mode"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}false{
"data": {
"session": "<string>",
"projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"project": {
"presence": "dark",
"typing": "off",
"reads": "off",
"pacing": "off",
"onlineStart": 11,
"onlineEnd": 11
},
"override": {
"presence": "inherit",
"typing": "inherit",
"reads": "inherit",
"pacing": "inherit"
},
"effective": {
"presence": "dark",
"typing": "off",
"reads": "off",
"pacing": "off",
"onlineStart": 11,
"onlineEnd": 11
},
"applied": {
"observedAt": "2023-11-07T05:31:56Z",
"presence": "<string>",
"typing": "<string>",
"reads": "<string>",
"pacing": "<string>"
},
"mismatch": true,
"entitled": true,
"entitlementReason": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"request_id": "<string>",
"request_log_url": "<string>"
},
"data": null,
"docs": "<string>"
}