Worlds

Manages worlds configuration and lifecycle

Experimental feature: this API is likely to change.

Get worlds for an organization

get

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.

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringoptional

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text'

200

200

[
  {
    "documentId": "text",
    "name": "text",
    "description": "text",
    "pictureUrl": "https://example.com",
    "transient": true,
    "metadata": {
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "compute": {
      "group": "development",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Tiny",
        "configuration": null
      }
    },
    "runtime": {
      "build": {
        "channelId": "text",
        "tag": "text",
        "content": {
          "id": "text"
        }
      },
      "mapName": "text",
      "durationMinutes": 1,
      "capacity": 1,
      "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"
      ]
    },
    "admission": {
      "policy": "Open",
      "capacity": 1
    },
    "sessions": {
      "controlPolicy": "Unlimited",
      "streamingTicketPredicate": "text",
      "flags": {
        "ignoreExpiry": true,
        "ignoreSlotRenewalErrors": true,
        "ignoreParentMissing": true,
        "useImmediateMode": true
      }
    },
    "organizationId": "text",
    "projectId": "text",
    "launchContext": {
      "launchContextId": "text",
      "name": "text",
      "isActive": true,
      "publicDownload": {
        "enabled": true,
        "enforceAntiCheat": true,
        "allowMac": true,
        "allowIos": true
      },
      "isWorldTravelOnly": true,
      "worldId": "text",
      "description": "text",
      "errorPageUrl": "text",
      "okPageUrl": "text",
      "gdnStreaming": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": true,
        "useWindowedMode": true
      },
      "ubitusStreaming": {
        "gameLabel": "text",
        "gameChannel": "text"
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": true,
        "showProviderOptions": true,
        "useBuildVersion": true
      },
      "bypassBrowserRestrictions": true,
      "enableQueue": true,
      "capacity": 1,
      "buildInfo": {
        "buildChannelId": "text",
        "buildTag": "text",
        "buildType": "client"
      },
      "splashScreenUrl": "text",
      "deployment": {
        "region": "text",
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "version": "text"
      },
      "useWorldSessions": true,
      "pictureUrl": "text",
      "isPublic": true,
      "organizationId": "text",
      "projectId": "text",
      "artifactUrl": "text",
      "permissionVerb": "*"
    },
    "queueState": null
  }
]

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

Create a world

post

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

Authorizations

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

streamingobjectoptional

The streaming configuration for a world

computeobject · default: {}optional

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

networkingobjectoptional

The networking configuration of a world.

namestring · min: 1 · max: 64required

The name of a world

Pattern: ^.+\S.*$

descriptionstring · max: 256optional

The description of a world

pictureUrlstring · urioptional

The picture URL of a world

transientbooleanrequired

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

metadataobjectoptional

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

runtimeobjectrequired

manifestobjectoptional

The world manifest, describing server and client permissions.

admissionobjectoptional

sessionsobjectoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "streaming": {
      "gdn": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": true,
        "useWindowedMode": true
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": true,
        "showProviderOptions": true,
        "useBuildVersion": true
      },
      "ubitus": {
        "gameLabel": "text",
        "gameChannel": "text"
      }
    },
    "compute": {
      "group": "development",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Tiny",
        "configuration": null
      }
    },
    "name": "text",
    "description": "text",
    "pictureUrl": "https://example.com",
    "transient": true,
    "metadata": {
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "runtime": {
      "build": {
        "channelId": "text",
        "tag": "text",
        "content": {
          "id": "text"
        }
      },
      "mapName": "text",
      "durationMinutes": 1,
      "capacity": 1,
      "admissionPolicy": "Open"
    },
    "manifest": {
      "serverPermissions": [
        "text"
      ],
      "clientPermissions": [
        "text"
      ]
    },
    "admission": {
      "policy": "Open",
      "capacity": 1
    },
    "sessions": {
      "controlPolicy": "Unlimited",
      "streamingTicketPredicate": "text",
      "flags": {
        "ignoreExpiry": true,
        "ignoreSlotRenewalErrors": true,
        "ignoreParentMissing": true,
        "useImmediateMode": true
      }
    }
  }'

200

200

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

The world's ID, if created successfully

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

get

Authorizations

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/travel/locations/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

4XX

200

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

List of worlds that the client can launch into

Get the details of a world

get

Retrieves and returns the specified world and linked launch context.

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

200

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny",
      "configuration": null
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "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"
    ]
  },
  "admission": {
    "policy": "Open",
    "capacity": 1
  },
  "sessions": {
    "controlPolicy": "Unlimited",
    "streamingTicketPredicate": "text",
    "flags": {
      "ignoreExpiry": true,
      "ignoreSlotRenewalErrors": true,
      "ignoreParentMissing": true,
      "useImmediateMode": true
    }
  },
  "organizationId": "text",
  "projectId": "text",
  "launchContext": {
    "launchContextId": "text",
    "name": "text",
    "isActive": true,
    "publicDownload": {
      "enabled": true,
      "enforceAntiCheat": true,
      "allowMac": true,
      "allowIos": true
    },
    "isWorldTravelOnly": true,
    "worldId": "text",
    "description": "text",
    "errorPageUrl": "text",
    "okPageUrl": "text",
    "gdnStreaming": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab",
      "useCustomClient": true,
      "useWindowedMode": true
    },
    "ubitusStreaming": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": true,
      "showProviderOptions": true,
      "useBuildVersion": true
    },
    "bypassBrowserRestrictions": true,
    "enableQueue": true,
    "capacity": 1,
    "buildInfo": {
      "buildChannelId": "text",
      "buildTag": "text",
      "buildType": "client"
    },
    "splashScreenUrl": "text",
    "deployment": {
      "region": "text",
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "version": "text"
    },
    "useWorldSessions": true,
    "pictureUrl": "text",
    "isPublic": true,
    "organizationId": "text",
    "projectId": "text",
    "artifactUrl": "text",
    "permissionVerb": "*"
  }
}

The details for a world

Update the details of a world

patch

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

streamingobjectoptional

The streaming configuration for a world

namestring · min: 1 · max: 64optional

The name of a world

Pattern: ^.+\S.*$

descriptionstring · max: 256optional

The description of a world

pictureUrlstring · urioptional

metadataobjectoptional

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

computeobjectoptional

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

networkingobjectoptional

The networking configuration of a world.

runtimeobjectoptional

The world runtime fields that can be updated.

manifestobjectoptional

The world manifest, describing server and client permissions.

admissionobjectoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "streaming": {
      "gdn": {
        "cmsId": "text",
        "authorizationId": "text",
        "launchMode": "same-tab",
        "useCustomClient": true,
        "useWindowedMode": true
      },
      "streamManager": {
        "streamContextId": "text",
        "allowForceProvider": true,
        "showProviderOptions": true,
        "useBuildVersion": true
      },
      "ubitus": {
        "gameLabel": "text",
        "gameChannel": "text"
      }
    },
    "name": "text",
    "description": "text",
    "pictureUrl": "https://example.com",
    "metadata": {
      "annotations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "compute": {
      "group": "development",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Tiny",
        "configuration": null
      }
    },
    "runtime": {
      "build": {
        "channelId": "text",
        "tag": "text",
        "content": {
          "id": "text"
        }
      },
      "mapName": "text",
      "durationMinutes": 1,
      "capacity": 1,
      "admissionPolicy": "Open"
    },
    "manifest": {
      "serverPermissions": [
        "text"
      ],
      "clientPermissions": [
        "text"
      ]
    },
    "admission": {
      "policy": "Open",
      "capacity": 1
    }
  }'

200

403

404

200

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny",
      "configuration": null
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "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"
    ]
  },
  "admission": {
    "policy": "Open",
    "capacity": 1
  },
  "sessions": {
    "controlPolicy": "Unlimited",
    "streamingTicketPredicate": "text",
    "flags": {
      "ignoreExpiry": true,
      "ignoreSlotRenewalErrors": true,
      "ignoreParentMissing": true,
      "useImmediateMode": true
    }
  }
}

The updated world details

Delete a world

delete

Deletes the specified world.

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

200

No body

Empty response

Get world bot deployments

get

Get all bot deployments for the specified world

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

200

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

All bot deployments for a world

Create world bot deployment

post

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

descriptionstring · max: 2048optional

countnumberrequired

cpustring · regexoptional

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

memorystring · regexoptional

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

argsstring[]optional

durationMinutesnumberoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "description": "text",
    "count": 1,
    "cpu": "/[a-z]/",
    "memory": "/[a-z]/",
    "args": [
      "text"
    ],
    "durationMinutes": 1
  }'

200

200

No body

Default Response

Get world bot deployment

get

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

404

200

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

The details for a bot deployment

Update world bot deployment

patch

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Body

countnumberrequired

cpustring · regexoptional

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

memorystring · regexoptional

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

argsstring[]optional

durationMinutesnumberoptional

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "count": 1,
    "cpu": "/[a-z]/",
    "memory": "/[a-z]/",
    "args": [
      "text"
    ],
    "durationMinutes": 1
  }'

200

200

No body

Default Response

Delete world bot deployment

delete

Stop a bot deployment for the specified world

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

botDeploymentIdstringrequired

The ID of a bot deployment

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/bots/{botDeploymentId}/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

200

No body

Default Response

Get world deployments

get

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Query parameters

statusany of[]optional

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/deployments/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

[
  {
    "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": 1,
      "args": [
        "text"
      ]
    },
    "status": "Unknown"
  }
]

Details for the World's deployments

World update picture URL

patch

Update the picture URL of a world

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/pictureUrl/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

400

404

503

200

{
  "documentId": "text",
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "compute": {
    "group": "development",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Tiny",
      "configuration": null
    }
  },
  "runtime": {
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    },
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "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"
    ]
  },
  "admission": {
    "policy": "Open",
    "capacity": 1
  },
  "sessions": {
    "controlPolicy": "Unlimited",
    "streamingTicketPredicate": "text",
    "flags": {
      "ignoreExpiry": true,
      "ignoreSlotRenewalErrors": true,
      "ignoreParentMissing": true,
      "useImmediateMode": true
    }
  }
}

The updated world details

Get a list of all active roles for a world

get

Returns a list of all active roles for a world. Could be used to get all possible conditions that allow a user to access a world.

Authorizations

BearerAuthApiKeyAuth

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/roles/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

200

[
  {
    "roleId": "text",
    "name": "text",
    "groupCondition": {
      "identifiers": [
        "text"
      ],
      "conditionType": "allUsers",
      "isActive": true,
      "expiryDate": {
        "to": "text",
        "from": "text"
      },
      "capacity": 1,
      "guestToken": "text",
      "chainId": "1"
    }
  }
]

The roles that can access a world

Start a world

post

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.

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/start/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

No body

Empty response

Stop a world

post

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

Authorizations

Path parameters

worldIdstringrequired

The ID of a world

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/stop/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

No body

Empty response

Check if a user has access to a world

get

Authorizations

BearerAuthApiKeyAuth

Path parameters

worldIdstringrequired

The ID of a world

userIdstringrequired

The ID of a user

Header parameters

x-m2-organization-idstringrequired

The ID of an organization

x-m2-project-idstringrequired

The ID of a project

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://your-organization-id.m2worlds.io/api/worlds/{worldId}/users/{userId}/access/' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'x-m2-organization-id: text' \
  --header 'x-m2-project-id: text'

200

4XX

200

{
  "userId": "text",
  "hasAccess": true
}

Indicates if a user has access to a world