ApplicationInstallCreate

Application install create endpoints.

Deprecated

Get a list of create application install processes

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Install ID

fileIdinteger · integerRequired

ID of the file

fileNamestringRequired

Name of the file

fileSizeinteger · integerRequired

Size in bytes of the file

fileSHA256stringRequired

Archive file SHA-256 hash

statusinteger · integerRequired

Status of this file 1: File has been seen on your FTP account 2: Your file has stopped - regarding the upload as finished 3: File details have been stored 5: File has been moved to our main file server for further processing 6: Re-packing your original archive 7: Re-packing is done 10: Creating an SHA-256 hash of the archive 11: Hashing done 12: Mirroring the archive to global file servers 13: Mirroring is done 14: ApplicationInstall has been activated 125: Cancelled 1 126: Cancelled 2 127: ApplicationInstall creation is done 128: A permanent error has occurred

statusTextstringRequired

Status in text of this file

403

Invalid credentials

500

Internal Server Error

application/json

get

/v3/applicationInstall/create

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "fileId": 1,
    "fileName": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "status": 1,
    "statusText": "text",
    "mirrorState": [
      {
        "locationId": 1,
        "locationName": "text",
        "fileServerIds": [
          1
        ],
        "transfers": [
          {
            "fileServerId": 1,
            "progress": 1,
            "errorCount": 1,
            "retries": 1
          }
        ]
      }
    ]
  }
]

Deprecated

Create a new application installation process

post

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Body

application/json

applicationIdstringRequired

The application's ID this application install is coupled to

fileIdinteger · integerRequired

ID of the assignableFile. Can be obtained from GET /applicationInstall/assignable

osGroupIdinteger · integerRequired

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

namestringRequired

Application install name

versionstringRequired

Application install version

releaseNotesstring · nullableOptional

Game install release notes

installHasExeinteger · integerRequired

Does the archive contain the game instance executable?

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Install ID

fileIdinteger · integerRequired

ID of the file

fileNamestringRequired

Name of the file

fileSizeinteger · integerRequired

Size in bytes of the file

fileSHA256stringRequired

Archive file SHA-256 hash

statusinteger · integerRequired

Status of this file 1: File has been seen on your FTP account 2: Your file has stopped - regarding the upload as finished 3: File details have been stored 5: File has been moved to our main file server for further processing 6: Re-packing your original archive 7: Re-packing is done 10: Creating an SHA-256 hash of the archive 11: Hashing done 12: Mirroring the archive to global file servers 13: Mirroring is done 14: ApplicationInstall has been activated 125: Cancelled 1 126: Cancelled 2 127: ApplicationInstall creation is done 128: A permanent error has occurred

statusTextstringRequired

Status in text of this file

403

Invalid credentials

422

Unprocessable Entity

500

Internal Server Error

application/json

post

/v3/applicationInstall/create

HTTPcURLJavaScriptPython

POST /v3/applicationInstall/create HTTP/1.1
Host: api.i3d.net
PRIVATE-TOKEN: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 120

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

[
  {
    "id": 1,
    "fileId": 1,
    "fileName": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "status": 1,
    "statusText": "text",
    "mirrorState": [
      {
        "locationId": 1,
        "locationName": "text",
        "fileServerIds": [
          1
        ],
        "transfers": [
          {
            "fileServerId": 1,
            "progress": 1,
            "errorCount": 1,
            "retries": 1
          }
        ]
      }
    ]
  }
]

Deprecated

Get a create application install process

get

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

fileIdintegerRequired

The Id of the file

Responses

200

OK

application/json

idinteger · integerRead-onlyRequired

Install ID

fileIdinteger · integerRequired

ID of the file

fileNamestringRequired

Name of the file

fileSizeinteger · integerRequired

Size in bytes of the file

fileSHA256stringRequired

Archive file SHA-256 hash

statusinteger · integerRequired

Status of this file 1: File has been seen on your FTP account 2: Your file has stopped - regarding the upload as finished 3: File details have been stored 5: File has been moved to our main file server for further processing 6: Re-packing your original archive 7: Re-packing is done 10: Creating an SHA-256 hash of the archive 11: Hashing done 12: Mirroring the archive to global file servers 13: Mirroring is done 14: ApplicationInstall has been activated 125: Cancelled 1 126: Cancelled 2 127: ApplicationInstall creation is done 128: A permanent error has occurred

statusTextstringRequired

Status in text of this file

403

Invalid credentials

404

Invalid fileId

500

Internal Server Error

application/json

get

/v3/applicationInstall/create/{fileId}

HTTPcURLJavaScriptPython

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

[
  {
    "id": 1,
    "fileId": 1,
    "fileName": "text",
    "fileSize": 1,
    "fileSHA256": "text",
    "status": 1,
    "statusText": "text",
    "mirrorState": [
      {
        "locationId": 1,
        "locationName": "text",
        "fileServerIds": [
          1
        ],
        "transfers": [
          {
            "fileServerId": 1,
            "progress": 1,
            "errorCount": 1,
            "retries": 1
          }
        ]
      }
    ]
  }
]

Deprecated

Cancel a application installation process

delete

Authorizations

ApiKey

PRIVATE-TOKENstringRequired

Path parameters

fileIdintegerRequired

The Id of the file

Responses

204

No Content

403

Invalid credentials

404

Invalid fileId

500

Internal Server Error

application/json

delete

/v3/applicationInstall/create/{fileId}

HTTPcURLJavaScriptPython

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

No content