Sign In
API

builds.prepare

Description

Creates a new project build for the given project.

Code Examples

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

Schema

Request Parameters

  • project
    nullable string query parameter
  • environment
    nullable string query parameter

Request

  • image_tag
    nullable string

    A tag given to the project build.

  • image_file
    object

    A file being prepared to upload.

    • image_file.path
      string

      The path/filename of the file.

    • image_file.content_type
      nullable string

      The MIME type of the file.

    • image_file.content_length
      integer

      Unsigned 64 bit integer.

  • kind
    nullable string
    • docker_image
    • oci_bundle
    • javascript
  • compression
    nullable string
    • none
    • lz4

Response

  • build
    string
  • presigned_requests
    array of objects
    • presigned_requests[].path
      string

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

    • presigned_requests[].url
      string

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

    • presigned_requests[].byte_offset
      integer

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

    • presigned_requests[].content_length
      integer

      Expected size of this upload.

Suggest changes to this page