Organization API: Organizations & Members: Gameproxy

The 2 Organization API operations for gameproxy.

View as Markdown

Operations

Method	Path	Summary
GET	`/api/v1/orgs/{org_slug}/gameproxy/settings`	The settings beside the platform's
PUT	`/api/v1/orgs/{org_slug}/gameproxy/settings`	Basedomainid must be one the GET lists: the brand's own or the platform's

The settings beside the platform's

Section titled The settings beside the platform's

GET /api/v1/orgs/{org_slug}/gameproxy/settings

The settings beside the platform's. base_domains are the ones a save may choose, the organization's own (org_id its id) before the platform's (org_id null); default_base_domain is what clear_base_domain puts it back to: its own first enabled one, else the platform's.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.

Basedomainid must be one the GET lists: the brand's own or the platform's

Section titled Basedomainid must be one the GET lists: the brand's own or the platform's

PUT /api/v1/orgs/{org_slug}/gameproxy/settings

base_domain_id must be one the GET lists: the brand's own or the platform's. Another brand's and an unknown id answer 422. clear_base_domain puts the choice back to the default (the brand's own enabled base domain, else the platform's), which effective_base_domain names; sent with a base_domain_id it answers 422. A change is written to the organization's audit log as gameproxy.settings_updated with the fields it sent.

Parameters

Section titled Parameters

Name	In	Type	Required
`org_slug`	path	string	yes

Request body

Section titled Request body

application/json (required)

Field	Type	Required
`auto_provision_minecraft`	boolean or null	no
`base_domain_id`	integer or null	no
`clear_base_domain`	boolean	no
`inherit_auto_provision`	boolean	no
`offline_motd`	string or null	no
`online_motd`	string or null	no
`generic_join_response`	string or null	no
`generic_ping_description`	string or null	no
`rejoin_message`	string or null	no
`blocked_message`	string or null	no
`favicon`	string or null	no
`version_name`	string or null	no
`status_cache_ttl_seconds`	integer or null	no
`clear_offline_motd`	boolean	no
`clear_online_motd`	boolean	no
`clear_generic_join_response`	boolean	no
`clear_generic_ping_description`	boolean	no
`clear_rejoin_message`	boolean	no
`clear_blocked_message`	boolean	no
`clear_favicon`	boolean	no
`clear_version_name`	boolean	no
`clear_status_cache_ttl_seconds`	boolean	no

Responses

Section titled Responses

Status	Meaning
`200`	Success.
`422`	The request is not valid. `detail` lists each problem.