launcher

Manages launcher download and lifecycle

Record the start of a streaming session

POSThttp://admin.m2worlds.io/api/launcher/checkin/

Authorization

BearerAuth

Body

application/json

launchId*string

UUIDv4 provided by the stream launcher.

sessionDurationSecs*integer

Duration cannot be negative.

providerName*any of

Provider must be 'gfn' or 'ubitus'.

enumenum

providerSpecstring

Provider machine spec if known, e.g. 'T4', 'g6.half'

Response

204207

Default Response

Body

application/json

object

Request

JavaScriptCurl

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

Response

{}

Returns the list of download configurations available for a given launcher download

GEThttp://admin.m2worlds.io/api/launcher/configurations/

Authorization

BearerAuth

Query parameters

Response

200

Default Response

Body

application/json

name*string

platform*any of

enumenum

pictureUrlstring

buildId*string

configurations*array of string

buildTags*array of string

Request

JavaScriptCurl

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

Response

{
  "name": "text",
  "platform": "windows",
  "pictureUrl": "text",
  "buildId": "text",
  "configurations": [
    "text"
  ],
  "buildTags": [
    "text"
  ]
}

Returns the URI for downloading an executable via the launcher

GEThttp://admin.m2worlds.io/api/launcher/download/{buildId}

Authorization

BearerAuth

Path parameters

buildId*string

Query parameters

Header parameters

Response

200

Default Response

Body

application/json

uri*string

Request

JavaScriptCurl

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

Response

{
  "uri": "text"
}

Service health check

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

Response

"text"

Returns the download URL for the launcher install

GEThttp://admin.m2worlds.io/api/launcher/install/

Authorization

BearerAuth

Query parameters

Response

200

Default Response

Body

application/json

link*string

Request

JavaScriptCurl

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

Response

{
  "link": "text"
}

Returns the download locations and execution information for a launcher-run executable

GEThttp://admin.m2worlds.io/api/launcher/launch/

Authorization

BearerAuth

Query parameters

Response

200

Default Response

Body

application/json

executable*object

downloadLocations*object

customizationobject

UX customization for the organization

Request

JavaScriptCurl

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

Response

{
  "executable": {
    "exe": "text",
    "args": [
      "text"
    ]
  },
  "downloadLocations": {
    "cas": {
      "url": "text",
      "cookie": "text"
    },
    "idx": {
      "url": "text",
      "cookie": "text"
    }
  },
  "customization": {
    "editorIconUrl": "text",
    "editorSplashUrl": "text"
  }
}

Exchanges a launcher token for a firebase custom auth token

GEThttp://admin.m2worlds.io/api/launcher/exchange/

Authorization

BearerAuth

Response

200

Default Response

Body

application/json

token*string

Request

JavaScriptCurl

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

Response

{
  "token": "text"
}