Worlds

Manages worlds configuration and lifecycle

Experimental feature: this API is likely to change.

Get worlds for an organization

Retrieves and returns all worlds that belong to the given Organization. Can also additionally filter by project if a project ID is passed in the headers.

GEThttps://your-organization-id.m2worlds.io/api/worlds/

Authorization

BearerAuth

Header parameters

Response

200

Lists all worlds for an organization or project (if specified)

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

compute*object

Includes details relating to the compute resources that are relevant for deploying the world.

networking*object

The networking configuration of a world.

runtime*object

status*object

The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.

manifestobject

The world manifest, describing server and client permissions.

organizationId*organizationId (string)

The ID of an organization

projectId*projectId (string)

The ID of a project

launchContextobject

The shape of a launch context and extra details including the Organization and Project scope

queueStateany

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text"
    },
});
const data = await response.json();

Response

200

[
  {
    "documentId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "https://example.com",
    "transient": false,
    "metadata": {},
    "compute": {
      "group": "development",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Tiny"
      }
    },
    "runtime": {
      "build": {
        "channelId": "text",
        "tag": "text",
        "content": {
          "id": "text"
        }
      },
      "mapName": "text",
      "durationMinutes": 0,
      "capacity": 0,
      "admissionPolicy": "Open"
    },
    "status": {
      "phase": "Inactive",
      "message": "text",
      "startedAt": "text",
      "resolvedBuild": {
        "channelId": "text",
        "tag": "text",
        "organizationId": "text",
        "id": "text"
      },
      "runId": "text"
    },
    "manifest": {
      "serverPermissions": [
        "text"
      ],
      "clientPermissions": [
        "text"
      ]
    },
    "organizationId": "text",
    "projectId": "text",
    "launchContext": {
      "launchContextId": "text",
      "name": "text",
      "isActive": false,
      "publicDownload": {
        "enabled": false,
        "enforceAntiCheat": false,
        "allowMac": false
      },
      "isWorldTravelOnly": false,
      "worldId": {},
      "description": "text",
      "errorPageUrl": "text",
      "okPageUrl": "text",
      "gdnStreaming": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": false,
        "useWindowedMode": false
      },
      "ubitusStreaming": {
        "gameLabel": "text",
        "gameChannel": "text"
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": false,
        "showProviderOptions": false,
        "useBuildVersion": false
      },
      "bypassBrowserRestrictions": false,
      "enableQueue": false,
      "capacity": 0,
      "buildInfo": {
        "buildChannelId": "text",
        "buildTag": "text",
        "buildType": "client"
      },
      "splashScreenUrl": "text",
      "deployment": {
        "region": "text",
        "version": "text"
      },
      "useWorldSessions": false,
      "pictureUrl": {},
      "organizationId": "text",
      "projectId": "text",
      "isPublic": false,
      "artifactUrl": "text",
      "permissionVerb": "*"
    }
  }
]

Create a world

Creates a world in the given Organization and Project. Checks if the user can create a world with the given size.

POSThttps://your-organization-id.m2worlds.io/api/worlds/

Authorization

BearerAuth

Header parameters

Body

application/json

streamingobject

The streaming configuration for a world

computeobject

Includes details relating to the compute resources that are relevant for deploying the world.

networkingobject

The networking configuration of a world.

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

runtime*object

manifestobject

The world manifest, describing server and client permissions.

Response

200

The world's ID, if created successfully

Body

application/json

worldId*string

The ID of a world

launchContextId*string

The ID of a launch context

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "transient": false,
      "runtime": {
        "build": {
          "channelId": "text",
          "tag": "text"
        },
        "mapName": "text"
      }
    }),
});
const data = await response.json();

Response

200

{
  "worldId": "text",
  "launchContextId": "text"
}

Service health check

GEThttps://your-organization-id.m2worlds.io/api/worlds/healthz

Response

200

Provides information about the service status.

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

text

Create a local world

POSThttps://your-organization-id.m2worlds.io/api/worlds/local/

Authorization

BearerAuth

Header parameters

Body

application/json

buildId*string

The ID of a build package

Response

200403

The new world's ID, if created successfully

Body

application/json

worldId*string

The ID of a world

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/local/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "buildId": "text"
    }),
});
const data = await response.json();

Response

200403

{
  "worldId": "text"
}

Get the details of a local world

GEThttps://your-organization-id.m2worlds.io/api/worlds/local/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

The details for a world

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

compute*object

Includes details relating to the compute resources that are relevant for deploying the world.

networking*object

The networking configuration of a world.

runtime*object

status*object

The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.

manifestobject

The world manifest, describing server and client permissions.

organizationId*string

projectId*string

launchContextobject

The shape of a launch context and extra details including the Organization and Project scope

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/local/{worldId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200404

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": false,
  "metadata": {},
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny"
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 0,
    "capacity": 0,
    "admissionPolicy": "Open"
  },
  "status": {
    "phase": "Inactive",
    "message": "text",
    "startedAt": "text",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    },
    "runId": "text"
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "organizationId": "text",
  "projectId": "text",
  "launchContext": {
    "launchContextId": "text",
    "name": "text",
    "isActive": false,
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false
    },
    "isWorldTravelOnly": false,
    "worldId": {},
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "bypassBrowserRestrictions": false,
    "enableQueue": false,
    "capacity": 0,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "splashScreenUrl": "text",
    "deployment": {
      "region": "text",
      "version": "text"
    },
    "useWorldSessions": false,
    "pictureUrl": {},
    "organizationId": "text",
    "projectId": "text",
    "isPublic": false,
    "artifactUrl": "text",
    "permissionVerb": "*"
  }
}

Authenticates with a local world

POSThttps://your-organization-id.m2worlds.io/api/worlds/local/{worldId}/auth/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

userType*any of

The user type to authenticate with this local world

enumenum

Response

200

Response sent for a successful local world authentication request

Body

application/json

accessToken*string

The World Access Token to be used for this user

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/local/{worldId}/auth/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userType": "Server"
    }),
});
const data = await response.json();

Response

200

{
  "accessToken": "text"
}

Returns a list of worlds that the client can launch in to

GEThttps://your-organization-id.m2worlds.io/api/worlds/travel/locations/

Authorization

BearerAuth

Response

2004XX

List of worlds that the client can launch into

Body

application/json

worlds*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/travel/locations/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

2004XX

{
  "worlds": [
    {
      "deployment": "text",
      "map": "text",
      "buildId": "text",
      "organizationId": "text",
      "projectId": "text",
      "launchContextId": "text",
      "launchContextName": "text",
      "worldId": "text",
      "liveConfigUrl": "text"
    }
  ]
}

Get the details of a world

Retrieves and returns the specified world and linked launch context.

GEThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

The details for a world

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

compute*object

Includes details relating to the compute resources that are relevant for deploying the world.

networking*object

The networking configuration of a world.

runtime*object

status*object

The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.

manifestobject

The world manifest, describing server and client permissions.

organizationId*string

projectId*string

launchContextobject

The shape of a launch context and extra details including the Organization and Project scope

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200404

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": false,
  "metadata": {},
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny"
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 0,
    "capacity": 0,
    "admissionPolicy": "Open"
  },
  "status": {
    "phase": "Inactive",
    "message": "text",
    "startedAt": "text",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    },
    "runId": "text"
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "organizationId": "text",
  "projectId": "text",
  "launchContext": {
    "launchContextId": "text",
    "name": "text",
    "isActive": false,
    "publicDownload": {
      "enabled": false,
      "enforceAntiCheat": false,
      "allowMac": false
    },
    "isWorldTravelOnly": false,
    "worldId": {},
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": false,
      "useWindowedMode": false
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": false,
      "showProviderOptions": false,
      "useBuildVersion": false
    },
    "bypassBrowserRestrictions": false,
    "enableQueue": false,
    "capacity": 0,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "splashScreenUrl": "text",
    "deployment": {
      "region": "text",
      "version": "text"
    },
    "useWorldSessions": false,
    "pictureUrl": {},
    "organizationId": "text",
    "projectId": "text",
    "isPublic": false,
    "artifactUrl": "text",
    "permissionVerb": "*"
  }
}

Update the details of a world

Updates the specified world and returns the resulting new world data if successful.

PATCHhttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

streamingobject

The streaming configuration for a world

namestring

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

computeobject

Includes details relating to the compute resources that are relevant for deploying the world.

networkingobject

The networking configuration of a world.

runtimeobject

The world runtime fields that can be updated.

manifestobject

The world manifest, describing server and client permissions.

Response

200403404

The updated world details

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

compute*object

Includes details relating to the compute resources that are relevant for deploying the world.

networking*object

The networking configuration of a world.

runtime*object

status*object

The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.

manifestobject

The world manifest, describing server and client permissions.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200403404

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": false,
  "metadata": {},
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny"
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 0,
    "capacity": 0,
    "admissionPolicy": "Open"
  },
  "status": {
    "phase": "Inactive",
    "message": "text",
    "startedAt": "text",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    },
    "runId": "text"
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  }
}

Delete a world

Deletes the specified world.

DELETEhttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

Empty response

Body

application/json

deleteWorldResponse (not)

Empty response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

404

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Get world bot deployments

Get all bot deployments for the specified world

GEThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

All bot deployments for a world

Body

application/json

documentId*string

The ID of a bot deployment

descriptionstring

configuration*object

status*object

organizationId*string

projectId*string

worldId*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200404

[
  {
    "documentId": "text",
    "description": "text",
    "configuration": {
      "count": 0,
      "cpu": "text",
      "memory": "text",
      "args": [
        "text"
      ],
      "durationMinutes": 0
    },
    "status": {
      "phase": "Pending",
      "message": "text",
      "startedAt": 0,
      "worldStartedAt": "text",
      "cluster": {
        "name": "text",
        "computeGroup": "text"
      }
    },
    "organizationId": "text",
    "projectId": "text",
    "worldId": "text"
  }
]

Create world bot deployment

Create a bot deployment for the specified world with the provided bot count

POSThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

descriptionstring

count*number

cpustring (regex)

Pattern: ^\d+(m|\.\d\d?\d?)?$

memorystring (regex)

Pattern: ^\d+(\.\d+)?(m|k|Ki|M|Mi|G|Gi)?$

argsarray of string

durationMinutesnumber

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "count": 0
    }),
});
const data = await response.json();

Get world bot deployment

Get the details for a specific bot deployment for the specified world.

GEThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

botDeploymentId*string

The ID of a bot deployment

Header parameters

Response

200404

The details for a bot deployment

Body

application/json

documentId*string

The ID of a bot deployment

descriptionstring

configuration*object

status*object

organizationId*string

projectId*string

worldId*string

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200404

{
  "documentId": "text",
  "description": "text",
  "configuration": {
    "count": 0,
    "cpu": "text",
    "memory": "text",
    "args": [
      "text"
    ],
    "durationMinutes": 0
  },
  "status": {
    "phase": "Pending",
    "message": "text",
    "startedAt": 0,
    "worldStartedAt": "text",
    "cluster": {
      "name": "text",
      "computeGroup": "text"
    }
  },
  "organizationId": "text",
  "projectId": "text",
  "worldId": "text"
}

Update world bot deployment

Update a bot deployment for the specified world. This can be used to alter the bot count in a bot deployment.

PATCHhttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

botDeploymentId*string

The ID of a bot deployment

Header parameters

Body

application/json

count*number

cpustring (regex)

Pattern: ^\d+(m|\.\d\d?\d?)?$

memorystring (regex)

Pattern: ^\d+(\.\d+)?(m|k|Ki|M|Mi|G|Gi)?$

argsarray of string

durationMinutesnumber

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "count": 0
    }),
});
const data = await response.json();

Delete world bot deployment

Stop a bot deployment for the specified world

DELETEhttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

botDeploymentId*string

The ID of a bot deployment

Header parameters

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Get world deployments

Returns the specified world's deployments. Optionally can be filtered by status, provided in the query string.

GEThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/deployments/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Query parameters

Header parameters

Response

2004XX

Details for the World's deployments

Body

application/json

organizationId*organizationId (string)

The ID of an organization

projectId*string

The ID of a project

worldId*string

The ID of a world

runIdstring

The ID of a world

createdAt*string

id*string

The ID of a world deployment

networking*object

externalId*string

compute*object

runtime*object

status*any of

enumenumenumenumenumenumenumenum

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/deployments/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

2004XX

[
  {
    "organizationId": "text",
    "projectId": "text",
    "worldId": "text",
    "runId": "text",
    "createdAt": "text",
    "id": "text",
    "networking": {
      "scaling": {
        "profile": "Tiny"
      }
    },
    "externalId": "text",
    "compute": {
      "clusterName": "text",
      "group": "development",
      "region": "Europe",
      "version": "text"
    },
    "runtime": {
      "build": {
        "channelId": "text",
        "id": "text",
        "content": {
          "id": "text"
        }
      },
      "mapName": "text",
      "liveConfigUrl": "text",
      "durationMinute": 0,
      "args": [
        "text"
      ]
    },
    "status": "Unknown"
  }
]

World update picture URL

Update the picture URL of a world

PATCHhttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/pictureUrl/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200400404503

The updated world details

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

The name of a world

Pattern: ^.+\S.*$

descriptionstring

The description of a world

pictureUrlstring (uri)

The picture URL of a world

transient*boolean

Describes whether the world is transient. Transient worlds are automatically deleted once their duration expires and they are fully stopped.

metadataobject

The metadata of a world. Includes annotations and labels used to customize the world deployments.

compute*object

Includes details relating to the compute resources that are relevant for deploying the world.

networking*object

The networking configuration of a world.

runtime*object

status*object

The current status of a world. Contains information about the world phase, any message describing the current state and other contextual information.

manifestobject

The world manifest, describing server and client permissions.

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/pictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

200400404503

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": false,
  "metadata": {},
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny"
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 0,
    "capacity": 0,
    "admissionPolicy": "Open"
  },
  "status": {
    "phase": "Inactive",
    "message": "text",
    "startedAt": "text",
    "resolvedBuild": {
      "channelId": "text",
      "tag": "text",
      "organizationId": "text",
      "id": "text"
    },
    "runId": "text"
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  }
}

Start a world

Transitions the phase of the world to Starting, which will subsequently launch the underlying deployments. With this transition, the world run ID and startedAt timestamp are reset.

POSThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/start/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

2004XX

Empty response

Body

application/json

startWorldResponse (not)

Empty response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/start/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

4XX

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

Stop a world

Transition the world phase to Stopped, which subsequently stops underlying deployments.

POSThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/stop/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

2004XX

Empty response

Body

application/json

stopWorldResponse (not)

Empty response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/stop/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text"
    },
});
const data = await response.json();

Response

4XX

{
  "error": "text",
  "code": "text",
  "message": "text",
  "statusCode": 0
}

World add remote viewer

Add a remote viewer client to a running world if remote viewers are enabled for the world and one doesn't exist.

POSThttps://your-organization-id.m2worlds.io/api/worlds/{worldId}/remoteViewers/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

postWorldRemoteViewersRequest (object)

Configuration for adding remote viewers to a world

Response

200

Default Response

Request

JavaScriptCurlPython

const response = await fetch('https://your-organization-id.m2worlds.io/api/worlds/{worldId}/remoteViewers/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "x-m2-organization-id": "text",
      "x-m2-project-id": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();