Upload a piece of a package file

PUT

/v1/projects/{slug}/packages/{name}/{version}/files/{sha256}

curl --request PUT \
  --url 'https://api.gampeon.com/v1/projects/example/packages/example/example/files/example?offset=1' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/octet-stream' \
  --data binary

• Production

Send the file in pieces of at most chunkBytes (64 MB) in order. offset must equal the bytes the server has (received); after an interruption, read GET …/packages and continue there. With the last piece the server checks the SHA-256 and, for the .uplugin, that it has no code modules. Files that GAMPEON already has from an earlier version answer done: true right away.

Not available with access tokens.

Rate limit: 2000 per hour per account.

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

sha256

required

string

/^[a-f0-9]{64}$/

SHA-256 of the file, 64 lowercase hex characters

Query Parameters

offset

required

integer

Byte position of this piece in the file

Request Body^required

The bytes of this piece

Media typeapplication/octet-stream

string format: binary

Responses

200

Piece stored

Media typeapplication/json

object

received

required

integer

size

required

integer

done

required

boolean

Example ^generated

{
  "received": 1,
  "size": 1,
  "done": true
}

400

Error codes: upload_aborted, 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"
}

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: offset_mismatch, version_ready

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"
}

411

Error codes: length_required

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"
}

413

Error codes: chunk_too_large

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"
}

422

Error codes: checksum_mismatch, invalid_package

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"
}

429

Limit: 2000 per hour per account. Error codes: rate_limited

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"
}

507

Error codes: storage_full

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"
}