Beamable Basic API
The Basic API from Beamable — 43 operation(s) for basic.
The Basic API from Beamable — 43 operation(s) for basic.
openapi: 3.0.2
info:
title: realms Basic API
version: '1.0'
contact:
name: Beamable Support
url: https://api.beamable.com
email: support@beamable.com
servers:
- url: https://api.beamable.com
security: []
tags:
- name: Basic
paths:
/basic/realms/customer/activate:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
text/html:
schema:
$ref: '#/components/schemas/HtmlResponse'
'400':
description: Bad Request
parameters:
- name: token
in: query
schema:
type: string
required: true
- name: cid
in: query
schema:
type: integer
format: int64
required: true
security:
- {}
tags:
- Basic
/basic/realms/project/beamable:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/customer/alias/available:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/AliasAvailableResponse'
'400':
description: Bad Request
parameters:
- name: alias
in: query
schema:
type: string
required: true
security:
- {}
tags:
- Basic
/basic/realms/project:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectView'
'400':
description: Bad Request
security:
- {}
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateProjectRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UnarchiveProjectRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveProjectRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/customer/verify:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerRequest'
security:
- {}
tags:
- Basic
/basic/realms/games:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetGameResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
tags:
- Basic
/basic/realms/config:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigChangeRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfigSaveRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/project/rename:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RenameProjectRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/plans:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/ServicePlansResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreatePlanRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/client/defaults:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/RealmConfiguration'
'400':
description: Bad Request
security:
- {}
tags:
- Basic
/basic/realms/customer:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerViewResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewCustomerRequest'
security:
- {}
tags:
- Basic
/basic/realms/admin/inflight/failures:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/InFlightFailureResponse'
'400':
description: Bad Request
parameters:
- name: serviceObjectId
in: query
schema:
type: string
required: false
- name: serviceName
in: query
schema:
type: string
required: true
security:
- user:
- developer
- server: []
tags:
- Basic
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BatchDeleteInFlightRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/launch-message:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/LaunchMessageListResponse'
'400':
description: Bad Request
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateLaunchMessageRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveLaunchMessageRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/is-customer:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/EmptyResponse'
'400':
description: Bad Request
security:
- {}
tags:
- Basic
/basic/realms/admin/customer:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerResponse'
'400':
description: Bad Request
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/game:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetGameResponse'
'400':
description: Bad Request
parameters:
- name: rootPID
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewGameRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateGameHierarchyRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/project/promote:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponseOld'
'400':
description: Bad Request
parameters:
- name: sourcePid
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
- name: promotions
in: query
schema:
type: array
items:
type: string
format: blah
required: false
- name: contentManifestIds
in: query
schema:
type: array
items:
type: string
format: blah
required: false
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponseOld'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/realms/customers:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CustomersResponse'
'400':
description: Bad Request
security:
- {}
tags:
- Basic
/basic/realms/promotion:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponse'
'400':
description: Bad Request
parameters:
- name: sourcePid
in: query
schema:
type: string
x-beamable-semantic-type: Pid
required: true
- name: promotions
in: query
schema:
type: array
items:
type: string
format: blah
required: false
- name: contentManifestIds
in: query
schema:
type: array
items:
type: string
format: blah
required: false
security:
- user:
- tester
- server: []
tags:
- Basic
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PromoteRealmRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/beamo/microservice/registrations:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MicroserviceRegistrationsResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MicroserviceRegistrationsQuery'
security:
- user:
- tester
- server: []
tags:
- Basic
/basic/beamo/microservice/federation/traffic:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
put:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MicroserviceRegistrationRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
delete:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/CommonResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MicroserviceRegistrationRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/beamo/image/urls:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PreSignedUrlsResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetServiceURLsRequest'
security:
- user:
- developer
- server: []
tags:
- Basic
/basic/beamo/metricsUrl:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetSignedUrlResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/GetMetricsUrlRequest'
security:
- user:
- tester
- server: []
tags:
- Basic
/basic/beamo/microservice/secret:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/MicroserviceSecretResponse'
'400':
description: Bad Request
security:
- user:
- admin
- server: []
tags:
- Basic
/basic/beamo/queryLogs/result:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
post:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetSignedUrlResponse'
'400':
description: Bad Request
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Query'
security:
- user:
- tester
- server: []
tags:
- Basic
/basic/beamo/storage/performance:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceResponse'
'400':
description: Bad Request
parameters:
- name: endDate
in: query
schema:
type: string
required: false
- name: storageObjectName
in: query
schema:
type: string
required: true
- name: granularity
in: query
schema:
type: string
required: true
- name: startDate
in: query
schema:
type: string
required: false
- name: period
in: query
schema:
type: string
required: false
security:
- user:
- admin
- server: []
tags:
- Basic
/basic/beamo/manifests:
parameters:
- name: X-BEAM-SCOPE
in: header
schema:
type: string
description: Customer and project scope. This should be in the form of '<customer-id>.<project-id>'.
required: true
- name: X-BEAM-GAMERTAG
in: header
schema:
type: string
description: Override the Gamer Tag of the player. This is generally inferred by the auth token.
required: false
get:
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/GetManifestsResponse'
'400':
description: Bad Request
parameters:
- name: offset
in: query
schema:
type: integer
format: int32
required: false
- name: limit
in: query
schema:
type: integer
format: int32
required: false
- name: archived
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/beamable/refs/heads/main/openapi/beamable-basic-api-openapi.yml