Skip to content

Create a new version

POST
/version

Create a new version of the engine.

Authorizations

Request Body required

object
name
required

Name of the version

string
Version 1.0.0
version_number
required

The version number. Ideally will follow semantic versioning

string
1.0.0
changelog

The changelog for this version

string
nullable
List of changes in this version...
changelog_url

A direct URL to the changelog for this version

string
nullable
https://example.com/changelog
version_type

The release channel for this version

string
Allowed values: release beta alpha
release
status

The current status of the version

string
Allowed values: listed archived draft unlisted scheduled unknown
listed
file_parts
required

An array of the multipart field names of each file that goes with this version

Array<string>

Responses

200

Version created successfully

object
name

Name of the version

string
Version 1.0.0
version_number

The version number. Ideally will follow semantic versioning

string
1.0.0
changelog

The changelog for this version

string
nullable
List of changes in this version...
changelog_url

A direct URL to the changelog for this version

string
nullable
https://example.com/changelog
version_type

The release channel for this version

string
Allowed values: release beta alpha
release
status

The current status of the version

string
Allowed values: listed archived draft unlisted scheduled unknown
listed
id
required

Unique identifier for the version (cuid2)

string
uohlw2d5lfh5pdgaavtsw9v6
author_id
required

The ID of the author who published this version (cuid2)

string
dtgc58bc5olg7wlvhb10xpy6
date_published
required

The date this version was published, in ISO 8601 format

string
2024-11-15T10:00:00Z
files
required

A list of files available for download for this version

Array<object>
object
hashes
required

A map of hashes of the file. The key is the hashing algorithm and the value is the string version of the hash

object
key
additional properties
string
{
"sha256": "abc123def456...",
"md5": "d41d8cd98f00b204e9800998ecf8427e"
}
url
required

A direct link to the file

string
https://example.com/my_file.exe
filename
required

The name of the file

string
my_file.exe
size
required

The size of the file in bytes

integer
1234567
platform
required

The platform for which the file is intended

string
windows

400

Invalid input

403

Forbidden - You are not authorized to create this version.