Skip to main content

HTTP API reference › Gala Launchpad › Platform Config

Gala Launchpad — Platform Config

6 operations in this group.

GET /v1​

SiteConfigController_getConfig[1]

Get platform configuration

Get platform configuration

Responses​

200 — Current platform feature configuration and AI moderation availability.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataPlatformConfigResponseDtoyes

400 — Platform configuration could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Platform configuration could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

PUT /v1​

SiteConfigController_updateConfig[1]

Update platform configuration (admin/overseer only)

Update platform configuration (admin/overseer only)

Authentication: bearer

Request body​

Required: yes

application/json​

Schema: UpdateConfigDto

FieldTypeRequiredDescription
aiModerationEnabledbooleanno
chatEnabledbooleanno
commentsEnabledbooleanno
streamingEnabledbooleanno
webhooksEnabledbooleanno

Responses​

200 — Updated platform configuration fields.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataPlatformConfigUpdateResponseDtoyes

400 — Invalid configuration​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

401 — Unauthorized​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

403 — Forbidden - insufficient permissions​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Configuration could not be updated.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example request​

[]

Example response​

[]

GET /v1/config​

SiteConfigController_getConfig[0]

Get platform configuration

Get platform configuration

Responses​

200 — Current platform feature configuration and AI moderation availability.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataPlatformConfigResponseDtoyes

400 — Platform configuration could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Platform configuration could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

PUT /v1/config​

SiteConfigController_updateConfig[0]

Update platform configuration (admin/overseer only)

Update platform configuration (admin/overseer only)

Authentication: bearer

Request body​

Required: yes

application/json​

Schema: UpdateConfigDto

FieldTypeRequiredDescription
aiModerationEnabledbooleanno
chatEnabledbooleanno
commentsEnabledbooleanno
streamingEnabledbooleanno
webhooksEnabledbooleanno

Responses​

200 — Updated platform configuration fields.​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataPlatformConfigUpdateResponseDtoyes

400 — Invalid configuration​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

401 — Unauthorized​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

403 — Forbidden - insufficient permissions​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

500 — Configuration could not be updated.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example request​

[]

Example response​

[]

GET /v1/config/roles​

SiteConfigController_getAvailableRoles[0]

Get available roles

Get available roles

Responses​

200 — Available roles retrieved successfully​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataAvailableRolesResponseyes

500 — Available roles could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

GET /v1/roles​

SiteConfigController_getAvailableRoles[1]

Get available roles

Get available roles

Responses​

200 — Available roles retrieved successfully​

Content type: application/json

Schema: ApiSuccessEnvelopeMetadataDto & object

FieldTypeRequiredDescription
errorboolean enum: falseyesSuccessful response marker.
messagestringyesResponse message.
statusnumberyesHTTP status code.
dataAvailableRolesResponseyes

500 — Available roles could not be retrieved.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

default — Shared error envelope returned by the application exception filter.​

Content type: application/json

Schema: ApiErrorEnvelope

FieldTypeRequiredDescription
errorboolean enum: trueyes
messageoneOf: string | array<string>yes
statusintegeryesHTTP status code.
messagestringyes
statusCodeintegeryesHTTP status code.

Example response​

[]

Previous group: oembed · Next group: AI Moderation