Worlds

The Worlds service manages virtual environments, each defined by World Builder content with custom runtime settings (map selection, session duration, etc.).

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

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringOptional

The ID of a project

Responses

200

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

application/json

get

/

HTTPcURLJavaScriptPython

GET /api/worlds/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
Accept: */*

200

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

[
  {
    "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": "production",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Capacity30",
        "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": false,
        "ignoreSlotRenewalErrors": false,
        "ignoreParentMissing": false,
        "useImmediateMode": false
      },
      "forceTravelWorldId": "text"
    },
    "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"
      },
      "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",
      "useWorldSessions": true,
      "pictureUrl": "text",
      "isPublic": true,
      "organizationId": "text",
      "projectId": "text",
      "permissionVerb": "*"
    },
    "queueState": {
      "queued": 1,
      "active": 1
    }
  }
]

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

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Body

application/json

The new world's details

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.

Responses

200

The world's ID, if created successfully

application/json

post

/

HTTPcURLJavaScriptPython

POST /api/worlds/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 1170

{
  "streaming": {
    "gdn": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": true,
      "showProviderOptions": true,
      "useBuildVersion": true
    },
    "ubitus": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "bypassBrowserRestrictions": true,
    "okPageUrl": "text",
    "errorPageUrl": "text"
  },
  "compute": {
    "group": "production",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Capacity30",
      "configuration": null
    }
  },
  "runtime": {
    "mapName": "text",
    "durationMinutes": 1,
    "capacity": 1,
    "admissionPolicy": "Open",
    "build": {
      "channelId": "text",
      "tag": "text",
      "content": {
        "id": "text"
      }
    }
  },
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "transient": true,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "manifest": {
    "serverPermissions": [
      "text"
    ],
    "clientPermissions": [
      "text"
    ]
  },
  "admission": {
    "policy": "Open",
    "capacity": 1
  },
  "sessions": {
    "controlPolicy": "Unlimited",
    "streamingTicketPredicate": "text",
    "flags": {
      "ignoreExpiry": false,
      "ignoreSlotRenewalErrors": false,
      "ignoreParentMissing": false,
      "useImmediateMode": false
    },
    "forceTravelWorldId": "text"
  }
}

200

The world's ID, if created successfully

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

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

get

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Responses

200

List of worlds that the client can launch into

application/json

4XX

The error object returned by the API when an error occurs

application/json

get

/travel/locations/

HTTPcURLJavaScriptPython

GET /api/worlds/travel/locations/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*

{
  "worlds": [
    {
      "deployment": "text",
      "map": "text",
      "buildId": "text",
      "organizationId": "text",
      "projectId": "text",
      "launchContextId": "text",
      "launchContextName": "text",
      "worldId": "text",
      "worldName": "text",
      "liveConfigUrl": "text",
      "contentId": "text",
      "metadata": {
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "queueState": {
        "queued": 1,
        "active": 1
      },
      "admission": {
        "policy": "Open",
        "capacity": 1
      }
    }
  ]
}

Resolve world build and content

post

Takes various build variables and resolves them to a single build package.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Body

application/json

anyOptional

The runtime build of a world. A build can be specified by a channel and tag, or by a content ID.

or

Responses

204

Build and content resolved successfully

4XX

The error object returned by the API when an error occurs

application/json

5XX

The error object returned by the API when an error occurs

application/json

post

/resolveBuildAndContent/

HTTPcURLJavaScriptPython

POST /api/worlds/resolveBuildAndContent/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "channelId": "text",
  "tag": "text",
  "content": {
    "id": "text"
  }
}

No content

Get scaling profiles

get

Retrieves all scaling profiles

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Responses

200

Lists all scaling profiles

application/json

get

/scalingProfiles/

HTTPcURLJavaScriptPython

GET /api/worlds/scalingProfiles/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*

200

Lists all scaling profiles

[
  {
    "name": "Capacity30",
    "estimatedCapacity": 1,
    "maxBotsPerWorld": 1,
    "resourceConfiguration": {
      "server": {
        "memoryLimit": "text"
      }
    }
  }
]

Get the details of a world

get

Retrieves and returns the specified world and linked launch context.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

The details for a world

application/json

404

The error object returned by the API when an error occurs

application/json

get

/{worldId}/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

{
  "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": "production",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Capacity30",
      "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": false,
      "ignoreSlotRenewalErrors": false,
      "ignoreParentMissing": false,
      "useImmediateMode": false
    },
    "forceTravelWorldId": "text"
  },
  "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"
    },
    "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",
    "useWorldSessions": true,
    "pictureUrl": "text",
    "isPublic": true,
    "organizationId": "text",
    "projectId": "text",
    "permissionVerb": "*"
  },
  "queueState": {
    "queued": 1,
    "active": 1
  }
}

Update the details of a world

patch

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

application/json

The world details to update. Partial updates of object fields are not allowed. All nested fields must be provided and optional fields will be reset to default.

publicDownloadany ofOptional

or

nullOptional

isPublicbooleanOptional

namestring · min: 1 · max: 64Optional

The name of a world

Pattern: ^.+\S.*$

descriptionstring · max: 256Optional

The description of a world

pictureUrlstring · uriOptional

Responses

200

The updated world details

application/json

403

Default Response

application/json

404

The error object returned by the API when an error occurs

application/json

patch

/{worldId}/

HTTPcURLJavaScriptPython

PATCH /api/worlds/{worldId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 1040

{
  "streaming": {
    "gdn": {
      "cmsId": "text",
      "authorizationId": "text",
      "launchMode": "same-tab"
    },
    "streamManager": {
      "streamContextId": "text",
      "allowForceProvider": true,
      "showProviderOptions": true,
      "useBuildVersion": true
    },
    "ubitus": {
      "gameLabel": "text",
      "gameChannel": "text"
    },
    "bypassBrowserRestrictions": true,
    "okPageUrl": "text",
    "errorPageUrl": "text"
  },
  "publicDownload": {
    "enabled": true,
    "enforceAntiCheat": true,
    "allowMac": true,
    "allowIos": true
  },
  "isPublic": true,
  "name": "text",
  "description": "text",
  "pictureUrl": "https://example.com",
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "compute": {
    "group": "production",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Capacity30",
      "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
  }
}

{
  "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": "production",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Capacity30",
      "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": false,
      "ignoreSlotRenewalErrors": false,
      "ignoreParentMissing": false,
      "useImmediateMode": false
    },
    "forceTravelWorldId": "text"
  }
}

Delete a world

delete

Deletes the specified world.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

Empty response

application/json

Responsenot

Empty response

404

The error object returned by the API when an error occurs

application/json

delete

/{worldId}/

HTTPcURLJavaScriptPython

DELETE /api/worlds/{worldId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Get world bot deployments

get

Get all bot deployments for the specified world

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

All bot deployments for a world

application/json

404

The error object returned by the API when an error occurs

application/json

get

/{worldId}/bots/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/bots/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

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

Create world bot deployment

post

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

application/json

Create a bot deployment

descriptionstring · max: 2048Optional

countnumberRequired

cpustring · regexOptionalPattern: ^\d+(m|\.\d\d?\d?)?$

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

argsstring[]Optional

durationMinutesnumberOptional

Responses

200

Default Response

No content

post

/{worldId}/bots/

HTTPcURLJavaScriptPython

POST /api/worlds/{worldId}/bots/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "description": "text",
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "count": 1,
  "cpu": "/[a-z]/",
  "memory": "/[a-z]/",
  "args": [
    "text"
  ],
  "durationMinutes": 1
}

200

Default Response

No content

Get world bot deployment

get

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

The details for a bot deployment

application/json

404

The error object returned by the API when an error occurs

application/json

get

/{worldId}/bots/{botDeploymentId}/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/bots/{botDeploymentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

{
  "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"
    }
  },
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "organizationId": "text",
  "projectId": "text",
  "worldId": "text"
}

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

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

application/json

Patch a bot deployment

countnumberRequired

cpustring · regexOptionalPattern: ^\d+(m|\.\d\d?\d?)?$

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

argsstring[]Optional

durationMinutesnumberOptional

Responses

200

Default Response

No content

patch

/{worldId}/bots/{botDeploymentId}/

HTTPcURLJavaScriptPython

PATCH /api/worlds/{worldId}/bots/{botDeploymentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Content-Type: application/json
Accept: */*
Content-Length: 188

{
  "count": 1,
  "cpu": "/[a-z]/",
  "memory": "/[a-z]/",
  "args": [
    "text"
  ],
  "durationMinutes": 1,
  "metadata": {
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}

200

Default Response

No content

Delete world bot deployment

delete

Stop a bot deployment for the specified world

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

Default Response

No content

delete

/{worldId}/bots/{botDeploymentId}/

HTTPcURLJavaScriptPython

DELETE /api/worlds/{worldId}/bots/{botDeploymentId}/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

200

Default Response

No content

Get world deployments

get

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Path parameters

worldIdstringRequired

The ID of a world

Query parameters

Header parameters

x-m2-organization-idstringRequired

The ID of an organization

x-m2-project-idstringRequired

The ID of a project

Responses

200

Details for the World's deployments

application/json

4XX

The error object returned by the API when an error occurs

application/json

get

/{worldId}/deployments/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/deployments/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

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

World update picture URL

patch

Update the picture URL of a world

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

The updated world details

application/json

400

The error object returned by the API when an error occurs

application/json

404

The error object returned by the API when an error occurs

application/json

503

The error object returned by the API when an error occurs

application/json

patch

/{worldId}/pictureUrl/

HTTPcURLJavaScriptPython

PATCH /api/worlds/{worldId}/pictureUrl/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

{
  "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": "production",
    "region": "Europe",
    "version": "text"
  },
  "networking": {
    "strategy": "Default",
    "scaling": {
      "profile": "Capacity30",
      "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": false,
      "ignoreSlotRenewalErrors": false,
      "ignoreParentMissing": false,
      "useImmediateMode": false
    },
    "forceTravelWorldId": "text"
  }
}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

The roles that can access a world

application/json

get

/{worldId}/roles/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/roles/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

200

The roles that can access a world

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

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

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

Empty response

application/json

Responsenot

Empty response

4XX

The error object returned by the API when an error occurs

application/json

post

/{worldId}/start/

HTTPcURLJavaScriptPython

POST /api/worlds/{worldId}/start/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Stop a world

post

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

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

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

200

Empty response

application/json

Responsenot

Empty response

4XX

The error object returned by the API when an error occurs

application/json

post

/{worldId}/stop/

HTTPcURLJavaScriptPython

POST /api/worlds/{worldId}/stop/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

No content

Check if a user has access to a world

get

Authorizations

BearerAuthApiKeyAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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

200

Indicates if a user has access to a world

application/json

4XX

HTTP error message

application/json

get

/{worldId}/users/{userId}/access/

HTTPcURLJavaScriptPython

GET /api/worlds/{worldId}/users/{userId}/access/ HTTP/1.1
Host: your-organization-id.m2worlds.io
Authorization: Bearer YOUR_SECRET_TOKEN
x-m2-organization-id: text
x-m2-project-id: text
Accept: */*

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

Get all public worlds across all organizations.

get

Retrieves and returns all worlds that are marked as public and active across all organizations.

Authorizations

ApiKeyAuthBearerAuth

x-api-keystringRequired

Responses

200

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

application/json

get

/public/

HTTPcURLJavaScriptPython

GET /api/worlds/public/ HTTP/1.1
Host: your-organization-id.m2worlds.io
x-api-key: YOUR_API_KEY
Accept: */*

200

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

[
  {
    "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": "production",
      "region": "Europe",
      "version": "text"
    },
    "networking": {
      "strategy": "Default",
      "scaling": {
        "profile": "Capacity30",
        "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": false,
        "ignoreSlotRenewalErrors": false,
        "ignoreParentMissing": false,
        "useImmediateMode": false
      },
      "forceTravelWorldId": "text"
    },
    "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"
      },
      "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",
      "useWorldSessions": true,
      "pictureUrl": "text",
      "isPublic": true,
      "organizationId": "text",
      "projectId": "text",
      "permissionVerb": "*"
    },
    "queueState": {
      "queued": 1,
      "active": 1
    }
  }
]