origin

Manages self-service world launching

Experimental feature: this API is likely to change.

Query user access to origin worlds workflows via permissions within projects

GEThttp://admin.m2worlds.io/api/origin/access/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

projects*array of object

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/access/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "projects": [
    {
      "documentId": "text",
      "name": "text",
      "scalingProfiles": [
        "Tiny"
      ]
    }
  ]
}

Query user access to origin editor download

GEThttp://admin.m2worlds.io/api/origin/access/editor

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

buildChannelEntries*array of any of

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/access/editor', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "buildChannelEntries": [
    {
      "type": "tag",
      "buildId": "text",
      "tagName": "text"
    }
  ]
}

Query the mods available to the user.

GEThttp://admin.m2worlds.io/api/origin/mods/

Header parameters

Response

200

Default Response

Body

application/json

modId*string

name*string

description*string

pictureUrl*string

liveContentId*string

canUserWrite*boolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/mods/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "modId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "text",
    "liveContentId": "text",
    "canUserWrite": false
  }
]

Updates a mod resource

PATCHhttp://admin.m2worlds.io/api/origin/mods/{modId}

Path parameters

modId*string

Header parameters

Body

application/json

mod*object

Response

200404

Default Response

Body

application/json

modId*string

name*string

description*string

pictureUrl*string

liveContentId*string

canUserWrite*boolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/mods/{modId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "mod": {}
    }),
});
const data = await response.json();

Response

{
  "modId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "text",
  "liveContentId": "text",
  "canUserWrite": false
}

Delete a mod.

DELETEhttp://admin.m2worlds.io/api/origin/mods/{modId}

Path parameters

modId*string

Header parameters

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/mods/{modId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Updates the picture URL of a mod

PATCHhttp://admin.m2worlds.io/api/origin/mods/{modId}/pictureUrl/

Authorization

BearerAuth

Path parameters

modId*string

Header parameters

Response

200400404503

Default Response

Body

application/json

modId*string

name*string

description*string

pictureUrl*string

liveContentId*string

canUserWrite*boolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/mods/{modId}/pictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "modId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "text",
  "liveContentId": "text",
  "canUserWrite": false
}

Updates the picture URL of a map

PATCHhttp://admin.m2worlds.io/api/origin/mods/{modId}/mapPictureUrl/

Authorization

BearerAuth

Path parameters

modId*string

Header parameters

Response

200400404503

Default Response

Body

application/json

mapPictureUrl*string

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/mods/{modId}/mapPictureUrl/', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "mapPictureUrl": "text"
}

Returns world builder data for the current org

GEThttp://admin.m2worlds.io/api/origin/configure/

Authorization

BearerAuth

Header parameters

Response

200

Default Response

Body

application/json

canWrite*boolean

projectId*string

buildChannelIdstring

buildIdstring

buildLabelstring

projectDataobject

The world builder data for projects in the organization

customizationobject

UX customization for the organization

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/configure/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

{
  "canWrite": false,
  "projectId": "text",
  "buildChannelId": "text",
  "buildId": "text",
  "buildLabel": "text",
  "customization": {
    "editorIconUrl": "text",
    "editorSplashUrl": "text"
  }
}

Sets world builder data for the relevant org

POSThttp://admin.m2worlds.io/api/origin/configure/

Authorization

BearerAuth

Header parameters

Body

application/json

projectIdstring

liveConfigNameDefaultstring

defaultBuildInfoobject

customizationobject

UX customization for the organization

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/configure/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Service health check

GEThttp://admin.m2worlds.io/api/origin/healthz

Response

200

Default Response

Body

application/json

statusMessage (string)

Provides information about the service status.

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

Create a new world role for a given world

POSThttp://admin.m2worlds.io/api/origin/roles/

Authorization

BearerAuth

Header parameters

Body

application/json

name*string

groupCondition*groupConditionSchema (object)

gameRoles*array of string

Response

200

Default Response

Body

application/json

roleId*string

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/roles/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "groupCondition": {
        "identifiers": [
          "text"
        ],
        "conditionType": "allUsers",
        "isActive": false
      },
      "gameRoles": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

{
  "roleId": "text"
}

Update a world role for a given world

PATCHhttp://admin.m2worlds.io/api/origin/roles/{roleId}

Authorization

BearerAuth

Path parameters

roleId*string

Header parameters

Body

application/json

namestring

groupConditiongroupConditionSchema (object)

gameRolesarray of string

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/roles/{roleId}', {
    method: 'PATCH',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete a world role for a given world

DELETEhttp://admin.m2worlds.io/api/origin/roles/{roleId}

Authorization

BearerAuth

Path parameters

roleId*string

Header parameters

Response

200

Default Response

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/roles/{roleId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Start a world using the provided configuration

POSThttp://admin.m2worlds.io/api/origin/worlds/

Header parameters

Body

application/json

name*string

buildId*string

contentId*string

mapPackageName*string

scalingProfile*any of

enumenumenumenum

rolesarray of object

durationMinsnumber

botCountnumber

remoteViewersEnabledboolean

Response

200

Default Response

Body

application/json

worldId*string

The ID of a world

launchContextId*string

The ID of a launch context

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/worlds/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "buildId": "text",
      "contentId": "text",
      "mapPackageName": "text",
      "scalingProfile": "Tiny"
    }),
});
const data = await response.json();

Response

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

Start a world using the provided configuration

GEThttp://admin.m2worlds.io/api/origin/worlds/

Header parameters

Response

200

Default Response

Body

application/json

id*string

name*string

isWritable*boolean

world*world (object)

The details of a world

launchContextId*launchContextId (string)

The ID of a launch context

modIdstring

deploymentoriginWorldsDeploymentSchema (object)

rolesarray of originWorldsRoleSchema (object)

botCountnumber

remoteViewersEnabledboolean

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/origin/worlds/', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "id": "text",
    "name": "text",
    "isWritable": false,
    "world": {
      "documentId": "text",
      "name": "text",
      "description": "text",
      "pictureUrl": "text",
      "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
      },
      "status": {
        "phase": "Inactive",
        "message": "text",
        "startedAt": "text",
        "resolvedBuild": {
          "channelId": "text",
          "tag": "text",
          "organizationId": "text",
          "id": "text"
        }
      }
    },
    "launchContextId": "text",
    "modId": "text",
    "deployment": {
      "region": "text",
      "status": "Unknown",
      "mapName": "text",
      "contentId": "text",
      "capacity": 0,
      "durationMins": 0,
      "createTime": 0,
      "gameRoles": [
        "text"
      ]
    },
    "roles": [
      {
        "id": "text",
        "name": "text",
        "groupCondition": {
          "identifiers": [
            "text"
          ],
          "conditionType": "allUsers",
          "isActive": false,
          "expiryDate": {
            "to": "text",
            "from": "text"
          },
          "capacity": 0,
          "guestToken": "text"
        },
        "gameRoles": [
          "text"
        ]
      }
    ],
    "botCount": 0,
    "remoteViewersEnabled": false
  }
]