platform.getPlatformSettings

GET

/v1/platform/settings

const url = 'https://example.com/v1/platform/settings';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/v1/platform/settings \
  --header 'Authorization: Bearer <token>'

Authorizations

token
session

Responses

200

Success

application/json

object

version

required

integer

<= 9007199254740991

publicOrigin

required

string

>= 1 characters

identityProvider

required

Any of:

object
null

object

issuer

required

string

>= 1 characters

clientId

required

string

>= 1 characters <= 512 characters

clientSecret

required

object

set

required

boolean

hint

required

Any of:

string
null

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
null

integer

>= 1 <= 1000000

tokenRate

required

object

organization

required

Any of:

object
null

object

tokensPerSecond

required

integer

>= 1 <= 10000000

burstTokens

required

integer

>= 1 <= 100000000

member

required

Any of:

object
null

object

tokensPerSecond

required

integer

>= 1 <= 10000000

burstTokens

required

integer

>= 1 <= 100000000

bot

required

Any of:

object
null

object

tokensPerSecond

required

integer

>= 1 <= 10000000

burstTokens

required

integer

>= 1 <= 100000000

token

required

Any of:

object
null

object

tokensPerSecond

required

integer

>= 1 <= 10000000

burstTokens

required

integer

>= 1 <= 100000000

files

required

object

storage

required

Any of:

object
null

object

endpoint

required

string

>= 1 characters

publicEndpoint

required

Any of:

string
null

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
null

string

uploads

required

object

server

required

boolean

direct

required

boolean

maxBytes

required

integer

>= 1 <= 5368709120

quotaBytes

required

Any of:

integer
null

integer

>= 1 <= 1125899906842624

mediaTypes

required

Array<string>

<= 100 items

unusedMs

required

integer

>= 60000 <= 31536000000

updatedAt

required

string

Example

{
  "organizationCreation": "anyone"
}

400

SettingsInvalid

application/json

object

_tag

required

string

Allowed values: SettingsInvalid

message

required

string

Example

{
  "_tag": "SettingsInvalid"
}

401

AuthenticationRequired

application/json

object

_tag

required

string

Allowed values: AuthenticationRequired

Example

{
  "_tag": "AuthenticationRequired"
}

403

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

application/json

Any of:

object

_tag

required

string

Allowed values: Forbidden

action

required

string

kind

required

string

field

string

reason

string

Example

{
  "_tag": "Forbidden"
}

409

SettingsConflict | @nmnmcc/ability/Authorizer/Pending

application/json

Any of:

object
object

object

_tag

required

string

Allowed values: SettingsConflict

version

required

integer

<= 9007199254740991

Example

{
  "_tag": "SettingsConflict"
}

503

PlatformUnavailable | OrganizationStorageUnavailable | SettingsUnavailable | AuthenticationUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: PlatformUnavailable

Example

{
  "_tag": "PlatformUnavailable"
}