Skip to main content
GET
curl

Authorizations

Authorization
string
header
required

An API key (sig_...), or a session token from the web app.

Path Parameters

agentId
string<uuid>
required

The agent's id.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"3f1c2d4e-5a6b-4c7d-8e9f-0a1b2c3d4e5f"

Query Parameters

from
integer
required

The older version, usually.

Required range: x >= 0
Example:

8

to
integer
required

The newer version, usually.

Required range: x >= 0
Example:

8

Response

The diff, the comparison and the stored comparison.

The configuration diff between two versions and what production did across them, with the stored comparison when Signal recorded one for that pair.

object
enum<string>
required
Available options:
version_diff
from
object
required
to
object
required
changes
object[] | null
required

What changed in the configuration from from to to, computed now from the captured configurations. Null when either was not captured: it cannot be diffed, which is not the same as nothing changed.

result
object
required

What production did from from to to, read the same way as a stored comparison and the web app's version page, so its Got it done on each side equals that version's gotItDone in the version list. Any pair, recorded or not.

comparison
object | null
required

The stored comparison for exactly this pair, in this order, when Signal recorded one (its id is what get_comparison takes). Null otherwise; most pairs that are not consecutive versions have none. Its result reads the same calls as result.