Skip to content
OpenBot

platform.updatePlatformSettings

PATCH
/v1/platform/settings
curl --request PATCH \
  --url https://example.com/v1/platform/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expectedVersion": 1, "publicOrigin": "example", "identityProvider": { "issuer": "example", "clientId": "example", "clientSecret": "example" }, "organizationCreation": "anyone", "ceiling": "example", "appRestrictions": [ { "cardUrl": "example", "reason": "example", "appealUrl": "example" } ], "codeMode": { "enabled": true, "timeoutMs": 1, "memoryMb": 1, "outputBytes": 1 }, "rateLimit": { "requestsPerMinute": 1 }, "tokenRate": { "organization": { "tokensPerSecond": 1, "burstTokens": 1 }, "member": { "tokensPerSecond": 1, "burstTokens": 1 }, "bot": { "tokensPerSecond": 1, "burstTokens": 1 }, "token": { "tokensPerSecond": 1, "burstTokens": 1 } }, "files": { "storage": { "endpoint": "example", "publicEndpoint": "example", "region": "example", "bucket": "example", "accessKeyId": "example", "forcePathStyle": true, "secretAccessKey": "example" }, "uploads": { "server": true, "direct": true }, "maxBytes": 1, "quotaBytes": 1, "mediaTypes": [ "example" ], "unusedMs": 1 } }'

Changes the platform settings. Send the version that you read as expectedVersion. Every instance uses the new settings right away. A new publicOrigin signs everyone out and changes the sign-in redirect URI.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
expectedVersion
required
integer
<= 9007199254740991
publicOrigin
string
>= 1 characters
identityProvider
Any of:
object
issuer
required
string
>= 1 characters
clientId
required
string
>= 1 characters <= 512 characters
clientSecret
Any of:
string
>= 1 characters <= 4096 characters
organizationCreation
string
Allowed values: anyone platform_admins
ceiling
string
appRestrictions
Array<object>
<= 1000 items
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string
codeMode
object
enabled
required
boolean
timeoutMs
required
integer
>= 100 <= 600000
memoryMb
required
integer
>= 8 <= 1024
outputBytes
required
integer
>= 1024 <= 4194304
rateLimit
object
requestsPerMinute
required
Any of:
integer
>= 1 <= 1000000
tokenRate
object
organization
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
member
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
bot
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
token
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
files
object
storage
Any of:
object
endpoint
required
string
>= 1 characters
publicEndpoint
required
Any of:
string
>= 1 characters
region
required
string
>= 1 characters <= 64 characters
bucket
required
string
accessKeyId
required
string
>= 1 characters <= 256 characters
forcePathStyle
required
boolean
secretAccessKey
string
>= 1 characters <= 4096 characters
uploads
object
server
required
boolean
direct
required
boolean
maxBytes
integer
>= 1 <= 5368709120
quotaBytes
Any of:
integer
>= 1 <= 1125899906842624
mediaTypes
Array<string>
<= 100 items
unusedMs
integer
>= 60000 <= 31536000000

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
version
required
integer
<= 9007199254740991
publicOrigin
required
string
>= 1 characters
identityProvider
required
Any of:
object
issuer
required
string
>= 1 characters
clientId
required
string
>= 1 characters <= 512 characters
clientSecret
required
object
set
required
boolean
hint
required
Any of:
string
organizationCreation
required
string
Allowed values: anyone platform_admins
ceiling
required
string
appRestrictions
required
Array<object>
<= 1000 items
object
cardUrl
required
string
reason
required
string
>= 1 characters
appealUrl
required
string
codeMode
required
object
enabled
required
boolean
timeoutMs
required
integer
>= 100 <= 600000
memoryMb
required
integer
>= 8 <= 1024
outputBytes
required
integer
>= 1024 <= 4194304
rateLimit
required
object
requestsPerMinute
required
Any of:
integer
>= 1 <= 1000000
tokenRate
required
object
organization
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
member
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
bot
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
token
required
Any of:
object
tokensPerSecond
required
integer
>= 1 <= 10000000
burstTokens
required
integer
>= 1 <= 100000000
files
required
object
storage
required
Any of:
object
endpoint
required
string
>= 1 characters
publicEndpoint
required
Any of:
string
>= 1 characters
region
required
string
>= 1 characters <= 64 characters
bucket
required
string
accessKeyId
required
string
>= 1 characters <= 256 characters
forcePathStyle
required
boolean
secretAccessKey
required
object
set
required
boolean
hint
required
Any of:
string
uploads
required
object
server
required
boolean
direct
required
boolean
maxBytes
required
integer
>= 1 <= 5368709120
quotaBytes
required
Any of:
integer
>= 1 <= 1125899906842624
mediaTypes
required
Array<string>
<= 100 items
unusedMs
required
integer
>= 60000 <= 31536000000
updatedAt
required
string

Example 

{
  "organizationCreation": "anyone"
}

400

Section titled “400”

SettingsInvalid

Media typeapplication/json
object
_tag
required
string
Allowed values: SettingsInvalid
message
required
string

Example 

{
  "_tag": "SettingsInvalid"
}

401

Section titled “401”

AuthenticationRequired

Media typeapplication/json
object
_tag
required
string
Allowed values: AuthenticationRequired

Example 

{
  "_tag": "AuthenticationRequired"
}

403

Section titled “403”

@nmnmcc/ability/Authorizer/Forbidden | MembershipRequired | ForbiddenOrigin

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: Forbidden
action
required
string
kind
required
string
field
string
reason
string

Example 

{
  "_tag": "Forbidden"
}

409

Section titled “409”

SettingsConflict | @nmnmcc/ability/Authorizer/Pending

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: SettingsConflict
version
required
integer
<= 9007199254740991

Example 

{
  "_tag": "SettingsConflict"
}

503

Section titled “503”

PlatformUnavailable | OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed

Media typeapplication/json
Any of:
object
_tag
required
string
Allowed values: PlatformUnavailable

Example 

{
  "_tag": "PlatformUnavailable"
}