linkThe release object
Below you will find the various attributes for the release resource, as well as the release resource's relationships. Release versioning must follow the semver spec.
linkAttributes
linkdata.attributes.name
stringThe human-readable name of the release. This can be used as an optional label.
linkdata.attributes.description
stringThe description of the release. Useful for releases notes and the like.
linkdata.attributes.channel
stringThe channel for the release. One of: stable, rc, beta, alpha, or dev.
linkdata.attributes.status
stringThe release's status. Draft and yanked releases are unlisted. One of:
DRAFT
,PUBLISHED
, orYANKED
.linkdata.attributes.tag
stringThe tag for the release, used for lookups. This can be an arbitrary string, e.g.
latest
orapp@latest
, or something reproducible, such as an MD5 or other checksum, to prevent duplicates. This value must be unique, even across products.linkdata.attributes.version
semverThe version of the release. This must be a valid semantic version (semver) string. Do not include a
v
prefix. This value must be unique per-product. The version may include prerelease and build tags.linkdata.attributes.semver
object<string, any>read onlyObject containing deconstructed key-value semver components.
linkdata.attributes.metadata
object<string, any>Object containing release metadata. This can be used to store things such as hash checksums, e.g. SHA-256 and SHA-512, for integrity verification after download, or for release notes.
linkRelationships
linkdata.relationships.environment
individualent onlyThese relationships are only available for accounts on an Ent tier.The environment that the release belongs to.
linkdata.relationships.entitlements
collectionThe entitlements constrained to the release (through constraints).
linkdata.relationships.constraints
collectionThe constraints for the release. Constraints can be used to require certain license entitlements in order to access a release, e.g.
ACCESS_V1
andACCESS_V2
. If the licensee lacks an entitlement constraint, access will be denied.linkdata.relationships.artifacts
collectionThe artifacts for the release. These represent files associated with the release.
Example object
{ "data": { "id": "30c64dcd-a74d-4f0d-8479-8745172a4817", "type": "releases", "attributes": { "name": "Keygen CLI v2.0.0-beta.2", "description": null, "channel": "beta", "status": "PUBLISHED", "tag": "latest", "version": "2.0.0-beta.2", "semver": { "major": 2, "minor": 0, "patch": 0, "prerelease": "beta.2", "build": null }, "metadata": {}, "created": "2022-05-31T14:26:09.319Z", "updated": "2022-05-31T14:48:33.913Z", "yanked": null }, "relationships": { "account": { "links": { "related": "/v1/accounts/<account>" }, "data": { "type": "accounts", "id": "<account>" } }, "product": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/product" }, "data": { "type": "products", "id": "0d5f0b57-3102-4ddf-beb9-f652cf8e24b7" } }, "package": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/package" }, "data": null }, "entitlements": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/entitlements" } }, "constraints": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/constraints" } }, "artifacts": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/artifacts" } }, "upgrade": { "links": { "related": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb/upgrade" } } }, "links": { "self": "/v1/accounts/<account>/releases/46003a57-3e0a-4fc8-99a8-0f089720f1eb" } }}