Create a release

Creates a new release.

POST/v3/releases
JWTrelease:write

Request body

namestringrequired

Name of the release. This can be a user friendly name to identify the release. Any printable characters, including letters from any script, punctuation and emoji. Cannot contain line breaks, tabs, other control characters, invisible formatting characters (zero-width and bidirectional marks), and cannot start or end with whitespace.

Length: [1,256]Pattern: ^(?!\s)(?!.*\s$)[^\p{Cc}\p{Cf}\p{Zl}\p{Zp}]+$

versionstringrequired

The version of the release. Only following three formats are allowed x.x, x.x.x, x.x.x.x.

Min length: 1

channelstringrequired

Channel of the release. The default value is 'stable'.

Length: [1,256]

productIdstringrequired

Unique identifier for the product.

Length: [1,256]

platformsarray of string

Platforms of the release. It will usually have the following values: windows, linux, macos, win32, win64 etc.

privateboolean

Private releases don't appear in the customer portal.

notesstring

Release notes for the release. It also supports markdown.

Length: [0,4096]

createdAtstring

This property should only be used for creating old releases.

Format: date-time

Response

201 Created

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
channelstringrequired
versionstringrequired
platformsarray of stringrequired
notesstringrequired
totalFilesintegerrequired

Format: int32

publishedbooleanrequired
privatebooleanrequired
archivedbooleanrequired
productIdstringrequired
tenantIdstringrequired
publishedAtstring

Format: date-time

filesarray of object