SHshorebird
patches

Register a new patch artifact and obtain an upload URL.

post/apps/{appId}/patches/{patchId}/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.

hash_signaturestring

The signature of the [hash], for a release whose binary embeds the customer's own key. Null for an unsigned patch. Refused (400) for a release whose binary embeds a managed key: the server signs those patches itself, and fails the request rather than store an unsigned one.

podfile_lock_hashstring

The sha256 hash of the Podfile.lock file, if a Podfile.lock file was involved in the creation of the patch (iOS only).

sizeinteger required

The size of the artifact in bytes.

Response

The newly-registered patch artifact.

idinteger required

The ID of the artifact.

patch_idinteger required

The ID of the patch.

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.