SHshorebird
patches

Check for an available patch for an install.

post/patches/check

Request

  • Base URL
    https://api.shorebird.dev/api/v1
  • Auth
    none required

Request body

release_versionstring required

The release version of the app.

patch_numberinteger

The highest patch number the client has already downloaded. If provided, the server only returns patches with a higher number. If omitted, the server returns the latest available.

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

A platform to which a Shorebird release can be deployed.

archstring required

The architecture of the app.

app_idstring required

The ID of the app.

channelstring required

The channel of the app.

client_idstring

Unique device ID for the install, generated on device and unique per app. Optional for backward compatibility.

current_patch_numberinteger

The patch number currently running on the device, if any. Supersedes patch_number for newer clients; unlike patch_number, this does not affect the server's response.

Response

The patch check result.

patch_availableboolean required

Whether a patch is available.

rolled_back_patch_numbersinteger[]

The numbers of all patches that have been rolled back for the current release.

Changes

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