worlds

Manages worlds configuration and lifecycle

Experimental feature: this API is likely to change.

Get worlds for an organization

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

Authorization

BearerAuth

Header parameters

Response

200404

Default Response

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

descriptionstring

pictureUrlstring (url)

transient*boolean

metadataobject

compute*object

networking*object

runtime*object

status*object

organizationId*string

projectId*string

Request

JavaScriptCurl

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

Response

[
  {
    "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"
      }
    },
    "organizationId": "text",
    "projectId": "text"
  }
]

Create a world

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

Authorization

BearerAuth

Header parameters

Body

application/json

streamingobject

The streaming configuration for a world

computeobject

networkingobject

name*string

descriptionstring

pictureUrlstring (url)

transient*boolean

metadataobject

runtime*object

Response

200403404

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/worlds/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "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

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

Patch a deployment

PATCHhttp://admin.m2worlds.io/api/worlds/deployments/{deploymentId}/

Path parameters

deploymentId*string

The ID of a deployment

Header parameters

Body

application/json

PatchDeploymentBody (any of)

The legacy request body for updating a deployment

objectobject

Response

2004XX

Default Response

Body

application/json

PatchDeploymentResponse (any of)

Updated deployment with status and IPs

objectobject

Request

JavaScriptCurl

const response = await fetch('http://admin.m2worlds.io/api/worlds/deployments/{deploymentId}/', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "ip": {},
      "status": "text"
    }),
});
const data = await response.json();

Response

{
  "organizationId": "text",
  "projectId": "text",
  "launchContextId": "text",
  "worldId": "text",
  "id": "text",
  "region": "text",
  "clusterName": "text",
  "ip": {
    "audioServer": {
      "externalIp": "text",
      "internalIp": "text",
      "port": 0
    },
    "mark": [
      {
        "externalIp": "text",
        "internalIp": "text",
        "port": 0
      }
    ],
    "proxies": [
      {
        "externalIp": "text",
        "internalIp": "text",
        "port": 0
      }
    ],
    "runtime": {
      "externalIp": "text",
      "internalIp": "text",
      "port": 0
    }
  },
  "versions": {
    "morpheus": "text",
    "colosseum": "text",
    "set": "text"
  },
  "status": "Unknown",
  "mapName": "text",
  "args": [
    "text"
  ],
  "liveContent": {
    "id": "text",
    "mapName": "text",
    "clientStartupMapName": "text"
  },
  "legacy": false,
  "legacyId": "text",
  "capacity": 0,
  "_liveConfigUrl": "text",
  "_entryScript": "text",
  "_duration": 0
}

Service health check

GEThttp://admin.m2worlds.io/api/worlds/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/worlds/healthz', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"text"

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

GEThttp://admin.m2worlds.io/api/worlds/travel/locations/

Authorization

BearerAuth

Response

2004XX

Default Response

Body

application/json

worlds*array of object

Request

JavaScriptCurl

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

Response

{
  "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

GEThttp://admin.m2worlds.io/api/worlds/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

Default Response

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

descriptionstring

pictureUrlstring (url)

transient*boolean

metadataobject

compute*object

networking*object

runtime*object

status*object

organizationId*string

projectId*string

Request

JavaScriptCurl

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

Response

{
  "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"
    }
  },
  "organizationId": "text",
  "projectId": "text"
}

Update the details of a world

PATCHhttp://admin.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

descriptionstring

pictureUrlstring (url)

metadataobject

computeobject

networkingobject

runtimeobject

Response

200403404

Default Response

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

descriptionstring

pictureUrlstring (url)

transient*boolean

metadataobject

compute*object

networking*object

runtime*object

status*object

Request

JavaScriptCurl

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

Response

{
  "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"
    }
  }
}

Delete a world

DELETEhttp://admin.m2worlds.io/api/worlds/{worldId}/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200404

Default Response

Body

application/json

deleteWorldResponse (not)

Empty response

Request

JavaScriptCurl

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

Add bots to a running world

POSThttp://admin.m2worlds.io/api/worlds/{worldId}/bots/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

botCount*number

Response

200

Default Response

Request

JavaScriptCurl

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

Update bot count for a running world

PATCHhttp://admin.m2worlds.io/api/worlds/{worldId}/bots/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Body

application/json

botCount*number

Response

200

Default Response

Request

JavaScriptCurl

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

Connect to a world

POSThttp://admin.m2worlds.io/api/worlds/{worldId}/connection/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Body

application/json

tokenFormat*any of

enumenumenum

serviceId*any of

enumenum

Response

2005034XX

Default Response

Body

application/json

organizationId*string

projectId*string

worldIdstring

launchContextIdstring

connection*object

metadataobject

Request

JavaScriptCurl

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

Response

{
  "organizationId": "text",
  "projectId": "text",
  "worldId": "text",
  "launchContextId": "text",
  "connection": {
    "id": 0,
    "token": "text",
    "endpoint": {
      "ip": "text",
      "port": 0
    }
  }
}

Returns the World's deployments, optionally filtered by status

GEThttp://admin.m2worlds.io/api/worlds/{worldId}/deployments/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Query parameters

Header parameters

Response

2004XX

Default Response

Body

application/json

organizationId*string

The ID of an organization

projectId*string

The ID of a project

worldId*string

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

JavaScriptCurl

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

Response

[
  {
    "organizationId": "text",
    "projectId": "text",
    "worldId": "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"
  }
]

Get a signed GCS URL to download latest Unreal server log

GEThttp://admin.m2worlds.io/api/worlds/{worldId}/deployments/{deploymentId}/logs/

Path parameters

deploymentId*string

The ID of a deployment

Header parameters

Response

2004XX5XX

Default Response

Body

application/json

downloadUrl*string

Request

JavaScriptCurl

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

Response

{
  "downloadUrl": "text"
}

Update the picture URL of a world

PATCHhttp://admin.m2worlds.io/api/worlds/{worldId}/pictureUrl/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

200400404503

Default Response

Body

application/json

documentId*worldId (string)

The ID of a world

name*string

descriptionstring

pictureUrlstring (url)

transient*boolean

metadataobject

compute*object

networking*object

runtime*object

status*object

Request

JavaScriptCurl

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

Response

{
  "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"
    }
  }
}

Start a world

POSThttp://admin.m2worlds.io/api/worlds/{worldId}/start/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

2004XX

Default Response

Body

application/json

startWorldResponse (not)

Empty response

Request

JavaScriptCurl

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

Stop a world

POSThttp://admin.m2worlds.io/api/worlds/{worldId}/stop/

Authorization

BearerAuth

Path parameters

worldId*string

The ID of a world

Header parameters

Response

2004XX

Default Response

Body

application/json

stopWorldResponse (not)

Empty response

Request

JavaScriptCurl

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

Add a remote viewer client to a running world

POSThttp://admin.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

JavaScriptCurl

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