Make a package version playable

POST

/v1/projects/{slug}/packages/{name}/{version}/finish

curl --request POST \
  --url https://api.gampeon.com/v1/projects/example/packages/example/example/finish \
  --header 'Authorization: Bearer <token>'

• Production

Checks that every file is uploaded and marks the version ready. From then on, players of your project’s servers that run this version get it when they press Play. Keeps the newest 3 ready versions of the package and deletes older ones.

Not available with access tokens.

Authorizations

• session

Parameters

Path Parameters

slug

required

string

Project slug

name

required

string

/^[A-Za-z][A-Za-z0-9_]{1,47}$/

Package name, as the Unreal plugin

version

required

string

/^\d{1,4}\.\d{1,4}\.\d{1,6}$/

Package version, such as 1.0.0

Responses

200

Version is ready

Media typeapplication/json

object

name

required

string

version

required

string

engine

required

string

status

required

ready once every file is uploaded and finish was called. Only ready versions reach players.

Allowed values: uploading ready

size

required

Bytes of all files

integer

received

required

Bytes uploaded so far

integer

files

required

Array<object>

object

path

required

string

size

required

integer

sha256

required

string

received

required

Bytes of this file uploaded so far

integer

done

required

boolean

createdAt

required

Unix time in milliseconds

integer format: int64

readyAt

required

One of:

integer

Unix time in milliseconds

integer format: int64

null

null

Example

{
  "status": "uploading"
}

401

Error codes: unauthorized

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

403

Error codes: token_not_allowed

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

404

Error codes: not_found

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

409

Error codes: upload_incomplete

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}

503

Error codes: packages_unavailable

Media typeapplication/json

object

error

required

Machine-readable error code, for example not_found or rate_limited.

string

message

Human-readable detail. Only present for some errors.

string

Example ^generated

{
  "error": "example",
  "message": "example"
}