Realms API - Revision history

imported>Dhtdht020: /* Defining a server */

2024-05-03T17:57:51Z

Defining a server

← Older revision		Revision as of 17:57, 3 May 2024
Line 82:		Line 82:
	\| parentWorldName \|\| Name of the parent realm that a snapshot realm is tied to \|\| String		\| parentWorldName \|\| Name of the parent realm that a snapshot realm is tied to \|\| String
	\|-		\|-
	\| compatibility \|\| Compatibility with the current game version. Can be one of the following: UNVERIFIABLE, INCOMPATIBLE, NEEDS_DOWNGRADE, NEEDS_UPGRADE, COMPATIBLE		\| compatibility \|\| Compatibility with the current game version. Can be one of the following: UNVERIFIABLE, INCOMPATIBLE, NEEDS_DOWNGRADE, NEEDS_UPGRADE, COMPATIBLE \|\| String
	\|-		\|-
	\| activeVersion \|\| Game version of the realm \|\| String		\| activeVersion \|\| Game version of the realm \|\| String

imported>Dhtdht020: Updated "Defining a server" table with newer fields and information

2024-05-03T17:57:20Z

Updated "Defining a server" table with newer fields and information

← Older revision		Revision as of 17:57, 3 May 2024
Line 50:		Line 50:
	\| name \|\| The name of the server \|\| String		\| name \|\| The name of the server \|\| String
	\|-		\|-
	\| motd \|\| The MOTD of the server. ~~Doesn't~~ support color. \|\| String		\| motd \|\| The MOTD of the server. Does support color codes, but officially color cannot be set. \|\| String
	\|-		\|-
	\| state \|\| The status of the server. Can be one of the following: ~~ADMIN_LOCK,~~ CLOSED, OPEN, UNINITIALIZED \|\| String		\| state \|\| The status of the server. Can be one of the following: CLOSED, OPEN, UNINITIALIZED \|\| String
	\|-		\|-
	\| daysLeft \|\| How many days are left of subscription. Always returns '0' if not owner and returns '-1' if expired \|\| Integer		\| daysLeft \|\| How many days are left of subscription. Always returns '0' if not owner and returns '-1' if expired \|\| Integer
Line 62:		Line 62:
	\| worldType \|\| Type of the world. Can be NORMAL, MINIGAME, ADVENTUREMAP, EXPERIENCE, INSPIRATION)\|\| String		\| worldType \|\| Type of the world. Can be NORMAL, MINIGAME, ADVENTUREMAP, EXPERIENCE, INSPIRATION)\|\| String
	\|-		\|-
	\| players \|\| A array of currently connected players? \|\| JSON Array, with string values		\| players \|\| An array of currently connected players? \|\| JSON Array, with string values
	\|-		\|-
	\| maxPlayers \|\| The max players of the server, always returns '10' \|\| Integer		\| maxPlayers \|\| The max players of the server, always returns '10' \|\| Integer
Line 77:		Line 77:
	\|-		\|-
	\| member \|\| Unknown \|\| Boolean		\| member \|\| Unknown \|\| Boolean
			\|-
			\| parentWorldId \|\| ID of the parent realm that a snapshot realm is tied to. Value of -1 on the parent realm \|\| Integer
			\|-
			\| parentWorldName \|\| Name of the parent realm that a snapshot realm is tied to \|\| String
			\|-
			\| compatibility \|\| Compatibility with the current game version. Can be one of the following: UNVERIFIABLE, INCOMPATIBLE, NEEDS_DOWNGRADE, NEEDS_UPGRADE, COMPATIBLE
			\|-
			\| activeVersion \|\| Game version of the realm \|\| String
	\|}		\|}

imported>Dhtdht020: Added findings on Java Realms environments.

2024-03-08T17:57:43Z

Added findings on Java Realms environments.

@@ Line 78: / Line 78: @@
 | member || Unknown || Boolean
 |}
 == Endpoints ==

imported>Plagiatus: /* PUT /worlds/$WORLD_ID/backups?backupId=$BACKUP_ID */ formatting

2023-02-10T17:22:33Z

PUT /worlds/$WORLD_ID/backups?backupId=$BACKUP_ID: formatting

← Older revision		Revision as of 17:22, 10 February 2023
Line 388:		Line 388:

	==== PUT /worlds/$WORLD_ID/backups?backupId=$BACKUP_ID ====		==== PUT /worlds/$WORLD_ID/backups?backupId=$BACKUP_ID ====
	Replaces the world of the realm with a backup.		Replaces the world of the realm with the specified backup.

	Response		'''Response'''

	Either returns "Retry again later" or "true". It seems to always return "Retry again later" on the first try.		Either returns <code>Retry again later</code> or <code>true</code>. It seems to always return "Retry again later" on the first try.

	==== PUT /worlds/$WORLD_ID/open ====		==== PUT /worlds/$WORLD_ID/open ====

imported>Plagiatus: /* PUT requests */ add apply backup.

2023-02-10T17:19:45Z

PUT requests: add apply backup.

← Older revision		Revision as of 17:19, 10 February 2023
Line 386:		Line 386:

	Send empty message if successful		Send empty message if successful

			==== PUT /worlds/$WORLD_ID/backups?backupId=$BACKUP_ID ====
			Replaces the world of the realm with a backup.

			Response

			Either returns "Retry again later" or "true". It seems to always return "Retry again later" on the first try.

	==== PUT /worlds/$WORLD_ID/open ====		==== PUT /worlds/$WORLD_ID/open ====
	Opens realm		Opens realm

imported>Plagiatus: changed bedrock.realms.minecraft.net to the actual used URL pocket.realms.minecraft.net

2021-09-10T11:57:46Z

changed bedrock.realms.minecraft.net to the actual used URL pocket.realms.minecraft.net

← Older revision		Revision as of 11:57, 10 September 2021
Line 3:		Line 3:
	The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.		The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.

	There is also an endpoint for Bedrock Edition in development, located at https://~~bedrock~~.realms.minecraft.net. It is being documented at [[Bedrock Realms]]		There is also an endpoint for Bedrock Edition in development, located at https://pocket.realms.minecraft.net. It is being documented at [[Bedrock Realms]]

	[[Category:Minecraft Modern]]		[[Category:Minecraft Modern]]

imported>Tim203: The url has also been changed from pocket to bedrock

2020-06-06T13:54:25Z

The url has also been changed from pocket to bedrock

← Older revision		Revision as of 13:54, 6 June 2020
Line 3:		Line 3:
	The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.		The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.

	There is also an endpoint for Bedrock Edition in development, located at https://~~pocket~~.realms.minecraft.net. It is being documented at [[Bedrock Realms]]		There is also an endpoint for Bedrock Edition in development, located at https://bedrock.realms.minecraft.net. It is being documented at [[Bedrock Realms]]

	[[Category:Minecraft Modern]]		[[Category:Minecraft Modern]]

imported>Tim203: Bedrock instead of Pocket

2020-06-06T13:45:26Z

Bedrock instead of Pocket

← Older revision		Revision as of 13:45, 6 June 2020
Line 3:		Line 3:
	The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.		The API endpoint for the Desktop Edition is located at https://pc.realms.minecraft.net. This is where all requests, as listed on this page, should be sent to.

	There is also an endpoint for ~~Pocket~~ Edition in development, located at https://pocket.realms.minecraft.net. It is being documented at [[~~Pocket~~ Realms]]		There is also an endpoint for Bedrock Edition in development, located at https://pocket.realms.minecraft.net. It is being documented at [[Bedrock Realms]]

	[[Category:Minecraft Modern]]		[[Category:Minecraft Modern]]

imported>Sirboys: /* Sessions */

2019-09-15T15:45:57Z

Sessions

← Older revision		Revision as of 15:45, 15 September 2019
Line 24:		Line 24:
	An example request:		An example request:
	GET /mco/available HTTP/1.1		GET /mco/available HTTP/1.1
	Cookie: sid=<token>;user=Herobrine;version=1.7.9		Cookie: sid=<token>;user=Herobrine;version=1.14.4
	Cache-Control: no-cache		Cache-Control: no-cache
	Pragma: no-cache		Pragma: no-cache

imported>TimmyRS: /* Notes */ has -> have

2019-09-14T20:32:01Z

Notes: has -> have

← Older revision		Revision as of 20:32, 14 September 2019
Line 33:		Line 33:

	== Notes ==		== Notes ==
	As per standard HTTP, a GET request has no parameters, and a POST request can potentially contain content (Note, several POST requests below ~~has~~ empty content).		As per standard HTTP, a GET request has no parameters, and a POST request can potentially contain content (Note, several POST requests below have empty content).

	== Defining a server ==		== Defining a server ==