builds.prepare


Description

Creates a new game build for the given game.


Code Examples

# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/games/{game_id}/environments/{environment_id}/builds/prepare'

Request Parameters

game_id

required path parameter

environment_id

required path parameter

Request Body

  • name
    string
  • image_tag
    string

    A tag given to the game build.

  • image_file
    object

    A file being prepared to upload.

    • image_file.path
      string

      The path/filename of the file.

    • image_file.content_type
      string

      The MIME type of the file.

    • image_file.content_length
      number

      Unsigned 64 bit integer.

  • multipart_upload
    boolean
  • kind
    string
  • compression
    string

Response Body

  • build
    string
  • image_presigned_request
    object

    A presigned request used to upload files. Upload your file to the given URL via a PUT request.

    • image_presigned_request.path
      string

      The name of the file to upload. This is the same as the one given in the upload prepare file.

    • image_presigned_request.url
      string

      The URL of the presigned request for which to upload your file to.

    • image_presigned_request.byte_offset
      number

      The byte offset for this multipart chunk. Always 0 if not a multipart upload.

    • image_presigned_request.content_length
      number

      Expected size of this upload.

  • image_presigned_requests
    array of objects
    • image_presigned_requests.path
      string

      The name of the file to upload. This is the same as the one given in the upload prepare file.

    • image_presigned_requests.url
      string

      The URL of the presigned request for which to upload your file to.

    • image_presigned_requests.byte_offset
      number

      The byte offset for this multipart chunk. Always 0 if not a multipart upload.

    • image_presigned_requests.content_length
      number

      Expected size of this upload.