Report a job's status (the runner, or the owner's side of a local run)

Not a customer route: the reporter is whoever moves the bytes, and the
job is loaded by its uuid across every account. Four credentials, one
of which must hold:

the cloud runner: Authorization: Bearer <MIGRATE_RUNNER_TOKEN>,
compared in constant time. Without the token configured this arm is
closed. The runner is the platform, so what it reports is believed.

the owner, for a local job: their own bearer session token.

a v1 transfer klock, for a local job: Authorization: klock <mac>
or X-Transfer-Klock: <mac>, the base64url HMAC-SHA256 with the
job's klockSecret over transfer/report/v1, a zero byte, then
<jobId>.<status>.<window> (the 30-second window, or the one
before). Not accepted for a v2 job.

a v2 on-device agent (a job created with klock: v2): the
agent's service session — transfer:report over exactly this job —
signs the whole request, body included, with its device key (RFC
9421, a single-use nonce): Authorization: Klock <grant>, or
Authorization: Klock device=<thumbprint> with Klock-Device-Pub
before it has synced a grant. Refusals: wrong_subject (403: not a
local job, or not this job's current agent), not_bound (403: the
job reports with its v1 klock), and the scheme's own
(grant_invalid, grant_expired, device_key_mismatch,
session_revoked, unauthenticated, …).

Anything the owner's side reports about a local run is self-reported:
an armed local run's end — completed, failed, restored or cancelled —
is billed at least the confirmed price and at least what the relay
metered; an under-report is flagged, and the certificate is marked
self-attested (or relay-metered).

The local-run metering receipt. receipt is a klock relay
receipt: a JWS the klock service signs with the keyset's klock key
when a relayed file transfer ends. It is counted before the report
(so the report is priced with it) when it verifies against the
current keyset, says completed, was sent or received by the job's
owner, began after the run was confirmed (60 s of skew), and has
never been counted before, for any job. Its bytes add to
meteredBytes. Ignored from the runner, which measures its own runs.

Unknown transitions are refused (409), so a job's status stays a true
account of where it is. On completed with a manifestDigest the
job's klock signs a certificate; a recurring job then re-arms to
queued for its next occurrence.

Capability: none from the table; the credential is its own (see above). Runner token, owner session, or job klock.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-Transfer-Klock

Example:

X-Transfer-Klock: ********************

Path Params

Body Params application/jsonRequired

Examples

curl --location 'https://api.prod-orm.io/transfer/jobs//events' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status": "created", "message": "string", "manifestDigest": "string", "bytes": 0, "error": "string", "receipt": "string" }'

{ "job": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "strategyId": "string", "scope": "string", "execution": "cloud", "direction": "cloud-cloud", "schedule": "string", "nextRunAt": "2019-08-24T14:15:22.123Z", "lastRunAt": "2019-08-24T14:15:22.123Z", "safe": true, "source": { "kind": "string", "property1": "string", "property2": "string" }, "dest": { "kind": "string", "property1": "string", "property2": "string" }, "tables": [ "string" ], "bytes": 0, "meteredBytes": 0, "cost": { "property1": "string", "property2": "string" }, "projectedCents": 0, "finalCents": 0, "confirmedAt": "2019-08-24T14:15:22.123Z", "billingMode": "immediate", "billedAt": "2019-08-24T14:15:22.123Z", "teamId": 0, "status": "created", "manifestDigest": "string", "certificate": { "property1": "string", "property2": "string" }, "error": "string", "log": [ { "at": "2019-08-24T14:15:22.123Z", "status": "string", "message": "string" } ], "startedAt": "2019-08-24T14:15:22.123Z", "finishedAt": "2019-08-24T14:15:22.123Z", "createdAt": "2019-08-24T14:15:22.123Z" } }

Report a job's status (the runner, or the owner's side of a local run)

Request

Responses