curl
curl -sS -X PUT "https://gateway.orbit/api/v1/conn/profiles/1/settings" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"version": 1, "settings": {"apps": {"path": "/srv/orbit/apps"}}}'{
"data": {
"profile_id": 123,
"version": 123,
"settings": {},
"sections": {},
"updated_at": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Conn
Replace profile settings sections
Replaces the sections of the settings document that the body holds (workspaces, appearance, devices; at least one) and keeps the others. devices replaces every device type and must hold at least one; a patch removes one type. Send the document version you last read; a stale version returns conn.settings_version_conflict (409) with details.current_version. Prefer conn:profile:settings:patch, which versions each section. An empty object is refused, a document over 4 MB returns validation.failed (422), and the document keys keep Conn camelCase.
PUT
/
api
/
v1
/
conn
/
profiles
/
{profile}
/
settings
curl
curl -sS -X PUT "https://gateway.orbit/api/v1/conn/profiles/1/settings" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"version": 1, "settings": {"apps": {"path": "/srv/orbit/apps"}}}'{
"data": {
"profile_id": 123,
"version": 123,
"settings": {},
"sections": {},
"updated_at": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Body
application/json