at.happyproto.server.getJob

One of the caller's own background jobs, such as the one a change to an instance started. Customers only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority

Details · query

Kind	query
Authority	server.happyproto.at
Indexed	22d ago · 2026-10-19

Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

id

requiredstring

The job's UUID.

Output

application/json

job

requiredref

Reference

#job

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not a HappyProto customer.

InvalidRequest

id is not a UUID.

NotFound

No such job, or the caller did not create it. The two are indistinguishable.

#job

object

A background job. Never carries its session fields.

Properties

error

string

Why the job failed. For an instance change, the operation's error code, then its message.

id

requiredstring

A UUID.

progress

unknown

The job's last progress report. For an instance change: {status, step?}, the operation's.

result

unknown

What the job returned, once completed.

status

requiredstring

knownValues: pending | running | paused | pausing | cancelling | completed | failed | cancelled

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

at.happyproto.admin.listJobs
query

Background jobs across every user, newest first. Staff only.
dev.cartridge.getMigrationJobStatus
query

Get the status of a migration background job.
at.happyproto.server.stopInstance
procedure

Stop one of the caller's instances, and start a job that follows the stop. Customers only.
app.bsky.video.getJobStatus
query

Get status details for a video processing job.
so.sprk.video.getJobStatus
query

Get status details for a video processing job.