SyncBot: Sync: new page from Minecraft

2026-10-20T11:05:00Z

Sync: new page from Minecraft

New page

{{exclusive|bedrock}}
{{WIP}}

The '''Bedrock Realms API response objects''' contain information about [[Minecraft:Realms]], players, backups, downloads, and invitation links. Their fields and data types are listed below. For endpoints and response examples, see [[Minecraft:Bedrock Realms API]].

== Realm object ==

Describes a Realm and the subscription, world, and membership information visible to the caller.

{| class="wikitable"
! scope="col" | Field
! scope="col" | Type
! scope="col" | Description
|-
! scope="row" | <code>id</code>
| Integer
| Realm identifier.
|-
! scope="row" | <code>remoteSubscriptionId</code>
| String
| Remote subscription identifier.
|-
! scope="row" | <code>owner</code>
| String or null
| Owner's username, mostly null.
|-
! scope="row" | <code>ownerUUID</code>
| String
| Owner's XUID, despite the field name.
|-
! scope="row" | <code>name</code>
| String
| Realm name.
|-
! scope="row" | <code>motd</code>
| String or null
| Realm description or message.
|-
! scope="row" | <code>defaultPermission</code>
| String
| Default player permission, such as <code>VISITOR</code>, <code>MEMBER</code>, or <code>OPERATOR</code>.
|-
! scope="row" | <code>state</code>
| String
| Realm state, such as <code>OPEN</code> or <code>CLOSED</code>.
|-
! scope="row" | <code>daysLeft</code>
| Integer
| Remaining subscription time in days. Values can be negative after expiry.
|-
! scope="row" | <code>expired</code>
| Boolean
| Whether the Realm subscription has expired.
|-
! scope="row" | <code>expiredTrial</code>
| Boolean
| Whether the Realm trial has expired.
|-
! scope="row" | <code>gracePeriod</code>
| Boolean
| Whether the subscription is in its grace period.
|-
! scope="row" | <code>worldType</code>
| String
| World type, such as <code>NORMAL</code>.
|-
! scope="row" | <code>players</code>
| Array or null
| Realm member records; see [[#Player object|Player object]]. Can include members who are offline.
|-
! scope="row" | <code>maxPlayers</code>
| Integer
| Maximum player capacity.
|-
! scope="row" | <code>activeSlot</code>
| Integer
| Selected world slot.
|-
! scope="row" | <code>slots</code>
| Array or null
| World slot records. The <code>options</code> field can contain [[Minecraft:wikipedia:JSON|JSON]] encoded as a string.
|-
! scope="row" | <code>member</code>
| Boolean
| Membership flag reported by the service.
|-
! scope="row" | <code>clubId</code>
| Integer or string
| Associated Xbox club identifier.
|-
! scope="row" | <code>minigameName</code>
| Unknown or null
| Minigame name, when supplied.
|-
! scope="row" | <code>minigameId</code>
| Unknown or null
| Minigame identifier, when supplied.
|-
! scope="row" | <code>minigameImage</code>
| Unknown or null
| Minigame image information, when supplied.
|-
! scope="row" | <code>subscriptionRefreshStatus</code>
| Unknown or null
| Subscription refresh information, when supplied.
|}

== Player object ==

Describes a Realm member and the permissions and activity flags reported for that member.

{| class="wikitable"
! scope="col" | Field
! scope="col" | Type
! scope="col" | Description
|-
! scope="row" | <code>uuid</code>
| String
| Player XUID.
|-
! scope="row" | <code>name</code>
| String or null
| Player name when supplied.
|-
! scope="row" | <code>operator</code>
| Boolean
| Whether the member is an operator.
|-
! scope="row" | <code>accepted</code>
| Boolean
| Whether the invitation has been accepted.
|-
! scope="row" | <code>online</code>
| Boolean
| Reported online status.
|-
! scope="row" | <code>permission</code>
| String
| Reported permission level.
|}

== Backup object ==

Identifies a saved world backup and its metadata.

{| class="wikitable"
! scope="col" | Field
! scope="col" | Type
! scope="col" | Description
|-
! scope="row" | <code>backupId</code>
| String
| Backup identifier used by download and restore routes.
|-
! scope="row" | <code>lastModifiedDate</code>
| Integer
| Modification time as a [[Minecraft:wikipedia:Unix|Unix]] timestamp in milliseconds.
|-
! scope="row" | <code>size</code>
| Integer
| Reported backup size in bytes.
|-
! scope="row" | <code>metadata</code>
| Object
| World details such as name, version, difficulty, game mode, and enabled packs. The values can be serialized strings.
|}

== Download object ==

Provides the download location and token for a world archive.

{| class="wikitable"
! scope="col" | Field
! scope="col" | Type
! scope="col" | Description
|-
! scope="row" | <code>downloadUrl</code>
| String
| Archive download location.
|-
! scope="row" | <code>token</code>
| String
| Token used when downloading the archive.
|-
! scope="row" | <code>size</code>
| Integer
| Reported download size in bytes.
|}

World archive downloads use <code>Authorization: Bearer {token}</code>, with the token supplied by the download object.

== Invite link object ==

Describes a Realm invite code and its web and game links.

{| class="wikitable"
! scope="col" | Field
! scope="col" | Type
! scope="col" | Description
|-
! scope="row" | <code>linkId</code>
| String
| Invite code.
|-
! scope="row" | <code>profileUuid</code>
| String
| Associated owner profile XUID.
|-
! scope="row" | <code>type</code>
| String
| Link type, such as <code>INFINITE</code>.
|-
! scope="row" | <code>ts</code>
| Integer
| Link creation timestamp.
|-
! scope="row" | <code>url</code>
| String
| Web link of the form <code>https://realms.gg/{linkId}</code>.
|-
! scope="row" | <code>deepLinkUrl</code>
| String
| Game link of the form <code>minecraft://acceptRealmInvite?inviteID={linkId}</code>.
|}

{{Navbox Bedrock Edition}}

[[Category:Bedrock Edition]]

Minecraft:Bedrock Realms API/Responses - Revision history

SyncBot: Sync: new page from Minecraft