ApplicationInstall

Application install endpoints

Deprecated

Get all your application installs

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Application install ID

applicationIdstringRequired

Application install assigned to applicationId

applicationTypeinteger · integer · nullableRequired

The list of Application types can be found in: GET /application/type

createdAtinteger · integerRead-onlyRequired

Application install created at timestamp

namestringRequired

Application install name

versionstringRequired

Application install version

osGroupIdinteger · integerRequired

Operating system group ID (1 = windows, 2 = linux)

activeinteger · integerRequired

Application install active

releaseNotesstring · nullableOptional

Application install release notes

filePathstringRead-onlyRequired

Path of the file on the file server

fileSizeinteger · integerRead-onlyRequired

File size in bytes

fileSHA256stringRead-onlyRequired

Archive file SHA-256 hash

executableSHA256stringRead-onlyRequired

SHA-256 hash of the executable in the archive

statusinteger · integerRead-onlyRequired

Status of application install.

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/applicationInstall

HTTPcURLJavaScriptPython

GET /v3/applicationInstall HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "applicationId": "text",
    "applicationType": 1,
    "createdAt": 1,
    "name": "text",
    "version": "text",
    "osGroupId": 1,
    "active": 1,
    "releaseNotes": "text",
    "filePath": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "executableSHA256": "text",
    "status": 1,
    "installHasExe": 1
  }
]

Deprecated

Get an application install

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

installIdintegerRequired

The Id of the application install to fetch

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Application install ID

applicationIdstringRequired

Application install assigned to applicationId

applicationTypeinteger · integer · nullableRequired

The list of Application types can be found in: GET /application/type

createdAtinteger · integerRead-onlyRequired

Application install created at timestamp

namestringRequired

Application install name

versionstringRequired

Application install version

osGroupIdinteger · integerRequired

Operating system group ID (1 = windows, 2 = linux)

activeinteger · integerRequired

Application install active

releaseNotesstring · nullableOptional

Application install release notes

filePathstringRead-onlyRequired

Path of the file on the file server

fileSizeinteger · integerRead-onlyRequired

File size in bytes

fileSHA256stringRead-onlyRequired

Archive file SHA-256 hash

executableSHA256stringRead-onlyRequired

SHA-256 hash of the executable in the archive

statusinteger · integerRead-onlyRequired

Status of application install.

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

403

Invalid credentials

404

Invalid installId

500

Internal Server Error

application/json

get

/v3/applicationInstall/{installId}

HTTPcURLJavaScriptPython

GET /v3/applicationInstall/{installId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "applicationId": "text",
    "applicationType": 1,
    "createdAt": 1,
    "name": "text",
    "version": "text",
    "osGroupId": 1,
    "active": 1,
    "releaseNotes": "text",
    "filePath": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "executableSHA256": "text",
    "status": 1,
    "installHasExe": 1
  }
]

Deprecated

Update an application install

put

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

installIdintegerRequired

The Id of the application install to update

Body

application/json

idinteger · integerRead-onlyRequired

Application install ID

applicationIdstringRequired

Application install assigned to applicationId

applicationTypeinteger · integer · nullableRequired

The list of Application types can be found in: GET /application/type

createdAtinteger · integerRead-onlyRequired

Application install created at timestamp

namestringRequired

Application install name

versionstringRequired

Application install version

osGroupIdinteger · integerRequired

Operating system group ID (1 = windows, 2 = linux)

activeinteger · integerRequired

Application install active

releaseNotesstring · nullableOptional

Application install release notes

filePathstringRead-onlyRequired

Path of the file on the file server

fileSizeinteger · integerRead-onlyRequired

File size in bytes

fileSHA256stringRead-onlyRequired

Archive file SHA-256 hash

executableSHA256stringRead-onlyRequired

SHA-256 hash of the executable in the archive

statusinteger · integerRead-onlyRequired

Status of application install.

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Application install ID

applicationIdstringRequired

Application install assigned to applicationId

applicationTypeinteger · integer · nullableRequired

The list of Application types can be found in: GET /application/type

createdAtinteger · integerRead-onlyRequired

Application install created at timestamp

namestringRequired

Application install name

versionstringRequired

Application install version

osGroupIdinteger · integerRequired

Operating system group ID (1 = windows, 2 = linux)

activeinteger · integerRequired

Application install active

releaseNotesstring · nullableOptional

Application install release notes

filePathstringRead-onlyRequired

Path of the file on the file server

fileSizeinteger · integerRead-onlyRequired

File size in bytes

fileSHA256stringRead-onlyRequired

Archive file SHA-256 hash

executableSHA256stringRead-onlyRequired

SHA-256 hash of the executable in the archive

statusinteger · integerRead-onlyRequired

Status of application install.

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

403

Invalid credentials

404

Invalid installId

422

Unprocessable Entity

500

Internal Server Error

application/json

put

/v3/applicationInstall/{installId}

HTTPcURLJavaScriptPython

PUT /v3/applicationInstall/{installId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 140

{
  "applicationId": "text",
  "applicationType": 1,
  "name": "text",
  "version": "text",
  "osGroupId": 1,
  "active": 1,
  "releaseNotes": "text",
  "installHasExe": 1
}

[
  {
    "id": 1,
    "applicationId": "text",
    "applicationType": 1,
    "createdAt": 1,
    "name": "text",
    "version": "text",
    "osGroupId": 1,
    "active": 1,
    "releaseNotes": "text",
    "filePath": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "executableSHA256": "text",
    "status": 1,
    "installHasExe": 1
  }
]

Deprecated

Remove (deactivate) an application install

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

installIdintegerRequired

The Id of the application install you want to remove

Responses

204

No Content

403

Invalid credentials

404

Invalid installId

409

Application install is in use, cannot delete

500

Internal Server Error

application/json

delete

/v3/applicationInstall/{installId}

HTTPcURLJavaScriptPython

DELETE /v3/applicationInstall/{installId} HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Accept: */*

No content