Modfile Object

Contains modfile data.

idinteger<int32>

Unique modfile id.

Example: 2

mod_idinteger<int32>

Unique mod id.

Example: 2

date_addedinteger<int32>

Unix timestamp of date file was added.

Example: 1499841487

date_updatedinteger<int32>

Unix timestamp of date file was updated.

Example: 1499841487

date_scannedinteger<int32>

Unix timestamp of date file was virus scanned.

Example: 1499841487

virus_statusVirus Scan Status Enum (integer)

Current virus scan status of the file. For newly added files that have yet to be scanned this field will change frequently until a scan is complete.

Enum Value	Description
NOT_SCANNED (0)	Not scanned
SCANNED (1)	Scan complete
SCAN_IN_PROGRESS (2)	In progress
FILE_TOO_LARGE (3)	Too large to scan
FILE_NOT_FOUND (4)	File not found
SCAN_ERROR (5)	Error Scanning

Possible values: [0, 1, 2, 3, 4, 5]

virus_positiveVirus Scan Enum (integer)

Was a virus detected.

Enum Value	Description
NO_THREATS_FOUND (0)	No threats detected
THREATS_FOUND (1)	Flagged as malicious
POTENTIALLY_HARMFUL (2)	Flagged as containing potentially harmful files (i.e. EXEs)

Possible values: [0, 1, 2]

virustotal_hashstring

Deprecated: No longer used and will be removed in subsequent API version.

Example:

filesizeinteger<int32>

Size of the file in bytes.

Example: 15181

filesize_uncompressedinteger<int32>

The uncompressed filesize of the zip archive.

Example: 16384

filehash object

Contains filehash data.

md5string

MD5 hash of the file.

Example: 2d4a0e2d7273db6b0a94b0740a88ad0d

filenamestring

Filename including extension.

Example: rogue-knight-v1.zip

versionstring

Release version this file represents.

Example: 1.3

changelogstring

Changelog for the file.

Example: VERSION 1.3 -- Changes -- Fixed critical castle floor bug.

metadata_blobstring

Metadata stored by the game developer for this file.

Example: rogue,hd,high-res,4k,hd textures

download object

Contains download data.

binary_urlstring

URL to download the file from the mod.io CDN.

NOTE: If the game requires mod downloads to be initiated via the API, the binary_url returned will contain a verification hash. This hash must be supplied to get the modfile, and will expire after a certain period of time. Saving and reusing the binary_url won't work in this situation given it's dynamic nature.

Example: https://api.mod.io.dev.internal/v1/games/1/mods/1/files/1/download/c489a0354111a4d76640d47f0cdcb294

date_expiresinteger

Unix timestamp of when the binary_url will expire.

Example: 1579316848

platforms object[]

Contains modfile platform data.

Array [

platformPlatform String Enum (string)

A target platform.

Enum Value	Description
ALL	All Platforms
WINDOWS	Windows
MAC	Mac
LINUX	Linux
ANDROID	Android
IOS	Iphone IOS
XBOXONE	Xbox One
XBOXSERIESX	Xbox Series X
PLAYSTATION4	Playstation 4
PLAYSTATION5	Playstation 5
SWITCH	Switch
OCULUS	Oculus
SOURCE	Source

Possible values: [ALL, WINDOWS, MAC, LINUX, ANDROID, IOS, XBOXONE, XBOXSERIESX, PLAYSTATION4, PLAYSTATION5, SWITCH, OCULUS, SOURCE]

Example: PLAYSTATION5

statusMod Platform Status Enum (integer)

The status of the modfile for the corresponding platform.

Enum Value	Description
PENDING (0)	Pending
APPROVED (1)	Approved
DENIED (2)	Denied
TARGETED (3)	Targeted

Possible values: [0, 1, 2, 3]

]

Modfile Object

{
  "id": 2,
  "mod_id": 2,
  "date_added": 1499841487,
  "date_updated": 1499841487,
  "date_scanned": 1499841487,
  "virus_status": 0,
  "virus_positive": 0,
  "virustotal_hash": "",
  "filesize": 15181,
  "filesize_uncompressed": 16384,
  "filehash": {
    "md5": "2d4a0e2d7273db6b0a94b0740a88ad0d"
  },
  "filename": "rogue-knight-v1.zip",
  "version": "1.3",
  "changelog": "VERSION 1.3 -- Changes -- Fixed critical castle floor bug.",
  "metadata_blob": "rogue,hd,high-res,4k,hd textures",
  "download": {
    "binary_url": "https://api.mod.io.dev.internal/v1/games/1/mods/1/files/1/download/c489a0354111a4d76640d47f0cdcb294",
    "date_expires": 1579316848
  },
  "platforms": [
    {
      "platform": "PLAYSTATION5",
      "status": 0
    }
  ]
}