Skip to content
Redot Experimental Documentation

Create a new version

POST
/version

This route creates a new version of the engine. Each new version must include at least one attached file, except when the new version’s status is draft.

The file_id field, which uniquely identifies each file, must be specified and can be obtained from the API release page.

Authorizations

Request Body required

object
data
required
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
github_release_url
required

URL to the GitHub release

string
https://github.com/username/repo/releases/tag/example
files
required

List of files associated with the version

Array<object>
object
file_id

Unique identifier for the file

string
8828197
platform

Target platform for the file (e.g., Windows, Linux, macOS)

string
windows
architecture

Architecture for the file (e.g., x86, x64, arm64)

string
x64
hash

Hash (e.g., SHA-512) for verifying file integrity

string
abc123def456...

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

A unique identifier for this version, using the CUID2 format

string
uohlw2d5lfh5pdgaavtsw9v6
author_id

The unique identifier of the author who published this version, formatted as CUID2

string
dtgc58bc5olg7wlvhb10xpy6
date_published

The date this version was published, in ISO 8601 format

string
2024-11-15T10:00:00Z
files
Array<object>

A list of files available for download for this version

object
hash

Hash (e.g., SHA-512) for verifying file integrity

string
abc123def456...
url

A direct link to the file

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

The name of the file

string
my_file.exe
size

The size of the file in bytes

integer
1234567
architecture

Architecture for the file (e.g., x86, x64, arm64)

string
x64
github_release_url

URL to the GitHub release

string
https://github.com/username/repo/releases/tag/example

400

Request was invalid, see given error

object
error
required

A short error code or message indicating the type of error

string
invalid_input
description
required

A detailed message explaining the reason for the error

string
The input JSON is missing required fields or contains invalid values

403

Forbidden - You are not authorized to create this version.