Skip to content
Exhale

Update Exhale

POST
/api/v1/update
curl --request POST \
  --url http://127.0.0.1:8484/api/v1/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dryRun": true }'

Owners only. Installs the newest release of Exhale where it runs: downloads it from GitHub, checks it against the release’s checksums, puts it in place of this version and restarts Exhale, which stops answering for a few seconds. Your data stays as it is, and a backup is taken before the database changes. It runs in the background: get_update follows it. Only where get_update says canApply; elsewhere it says the command to run.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
dryRun
boolean

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
available
required
boolean
canApply
required
boolean
checkError
string
checkedAt
string
command
string
current
required
string
download
string
latest
string
method
required
string
Allowed values: macos-app windows-app binary package docker
notes
string
notesUrl
string
progress
required
object
done
required
integer format: int64
error
string
phase
required
string
Allowed values: idle downloading installing restarting failed
total
required
integer format: int64
version
string
publishedAt
string
reason
string
Allowed values: "" development manual read-only unsupported

Example 

{
  "$schema": "https://example.com/api/schemas/VersionInfo.json",
  "method": "macos-app",
  "progress": {
    "phase": "idle"
  },
  "reason": ""
}

default

Section titled “default”

Error

Media typeapplication/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank

Example 

{
  "$schema": "https://example.com/api/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}