SHshorebird
releases

Register a new release artifact and obtain an upload URL.

The server returns a record for the artifact plus a signed upload URL; clients then POST the artifact bytes to that URL.

post/apps/{appId}/releases/{releaseId}/artifacts

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

archstring required

The arch of the artifact.

platform'android' | 'ios' | 'linux' | 'macos' | 'windows' required

A platform to which a Shorebird release can be deployed.

hashstring required

The hash of the artifact.

filenamestring required

The name of the file.

can_sideloadboolean

Whether the artifact can installed and run on a device/emulator as-is.

sizeinteger required

The size of the artifact in bytes.

podfile_lock_hashstring

The hash of the Podfile.lock file used to create this artifact (iOS only).

Response

The newly-registered release artifact.

idinteger required

The ID of the artifact.

release_idinteger required

The ID of the release.

archstring required

The arch of the artifact.

platform'android' | 'ios' | 'linux' | 'macos' | 'windows' required

A platform to which a Shorebird release can be deployed.

hashstring required

The hash of the artifact.

sizeinteger required

The size of the artifact in bytes.

urlstring required

The upload URL for the artifact.

upload_method'multipart' | 'resumable'

How a client should upload an artifact's bytes to storage.

Changes

No recorded changes to this operation across all 1 revision of this API.