DevelopAPIcore-services
Site settings
The settings of the whole site.
GET
header
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
The answer.
curl -X GET "https://platform.example.com/api/admin/configuration" \ -H "Authorization: Bearer $TOKEN"Empty
PUT
header
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
application/json- body
[key: string]?anyThe answer.
curl -X PUT "https://platform.example.com/api/admin/configuration" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{}'Empty
GET
header
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
Whether it is on, and what it would show.
application/json- response
meta?The copyright and name of the platform.
data?curl -X GET "https://platform.example.com/api/admin/public-access" \ -H "Authorization: Bearer $TOKEN"{ "meta": {}, "data": { "enabled": true, "publicItems": { "count": 0, "truncated": true, "groups": [ { "type": "string", "count": 0, "items": [ { "_id": "string", "name": "string", "subtype": "string", "owner": { "_id": "string", "displayName": "string" } } ] } ] } }}PUT
header
AuthorizationBearer <token>An access token of an OAuth client: Authorization: Bearer <token>.
application/json- body
enabled*booleantrue to turn it on, false to turn it off.
The state it is in now.
application/json- response
meta?The copyright and name of the platform.
data?curl -X PUT "https://platform.example.com/api/admin/public-access" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "enabled": false}'{ "meta": {}, "data": { "enabled": true }}