Object Glossary

Detailed below are the central objects used in the API. This documentation is generated from the OpenAPI spec, and the original ordering is preserved. See the API endpoints docs for information detailing usage.

---

Manifest

The central scan data object.

Used as output by:

• GET /scan/{scan_id}/manifest

• PATCH /scan/{scan_id}/manifest

• POST /scan

• POST /scan/{scan_id}/actions/rescan

• POST /scan/{scan_id}/ewms/workflow-id

• POST /scans/find

Fields:

Field	Type	Description
scan_id	string	Unique scan identifier.
timestamp	number
is_deleted	boolean
scanner_server_args	string	CLI args for the scanner server k8s job (sensitive values are obfuscated by obfuscate_cl_args).
ewms_workflow_id	string | null	EWMS workflow id. The sentinel not-yet-requested means SkyDriver has not yet sent the workflow request to EWMS (see has_skydriver_requested_ewms_workflow()).
ewms_address	string | null	EWMS address used to differentiate EWMS instances.
ewms_task	FreeFormObject | string	DEPRECATED – use ewms_workflow_id. Was used in SkyDriver 1.x for local k8s starter/stopper.
priority	integer	HTCondor-style job priority.
classifiers	object	Classifiers as stored on the manifest: scalar values or lists of scalars. (Compare with the stricter input shape used in POST /scan, which disallows lists and caps strings at 25 chars.)
> (any key)	string | boolean | number | integer | null | array of (string | boolean | number | integer | null)
i3_event_id	string	ID into the i3_event collection.
event_i3live_json_dict	FreeFormObject | string	DEPRECATED – use i3_event_id.
event_i3live_json_dict__hash	string | null	DEPRECATED.
event_metadata	object | null	Encapsulates the identity of an event (nullable).
scan_metadata	FreeFormObject | null	Open-ended metadata set by the scanner (nullable).
progress	object | null	Houses all the progress for a scan, updated throughout scanning (nullable).
replaced_by_scan_id	string | null	If set, this scan has been replaced – used by REST redirects.
last_updated	number

---

Result

Physics results for a scan.

Used as output by:

• GET /scan/{scan_id}/result

• PUT /scan/{scan_id}/result

Fields:

Field	Type	Description
scan_id	Manifest.scan_id	See field in Manifest.
skyscan_result	FreeFormObject	Physics result payload; keys/values are open to requestor. See FreeFormObject.
is_final	boolean

---

ScanBacklogEntry

An entry for the scan backlog used for rate-limiting.

Used as output by:

• GET /scans/backlog

Fields:

Field	Type	Description
scan_id	Manifest.scan_id	See field in Manifest.
timestamp	number	Timestamp when the entry was added to the backlog (distinct from Manifest.timestamp).
pickled_k8s_job	string | null	DEPRECATED – replaced by SkyScanK8sJob in db.
priority	Manifest.priority	See field in Manifest.
pending_timestamp	number
next_attempt	integer

---

ScanRequestObj

Persisted scan-request object (the input used to start a scan).

Used as output by:

• GET /scan-request/{scan_id}

Fields:

Field	Type	Description
scan_id	Manifest.scan_id	See field in Manifest.
rescan_ids	array of Manifest.scan_id	See field in Manifest.
docker_tag	string
scanner_server_memory_bytes	DataSize	See DataSize.
reco_algo	string
nsides	FreeFormObject	See FreeFormObject.
real_or_simulated_event	RealOrSimulatedEvent	See RealOrSimulatedEvent.
predictive_scanning_threshold	Manifest.progress.predictive_scanning_threshold	See field in Manifest.
classifiers	Manifest.classifiers	See field in Manifest.
request_clusters	RequestClusters	See RequestClusters.
worker_memory_bytes	DataSize	See DataSize.
worker_disk_bytes	DataSize	See DataSize.
max_pixel_reco_time	integer
priority	Manifest.priority	See field in Manifest.
debug_mode	array of string	DebugMode values (as strings – the Python enum’s .value).
i3_event_id	Manifest.i3_event_id	See field in Manifest.
scanner_server_env_from_user	ScannerServerEnvFromUser	See ScannerServerEnvFromUser.

---

SkyscanK8sJob

Fields:

Field	Type	Description
scan_id	Manifest.scan_id	See field in Manifest.
skyscan_k8s_job_dict	object	Raw Kubernetes job manifest/dict for the skyscan job.
> (any key)
k8s_started_ts	number | null	Unix timestamp (float) when the K8s job started, or null if not yet started.

---

I3Event

Fields:

Field	Type	Description
i3_event_id	Manifest.i3_event_id	See field in Manifest.
json_dict	FreeFormObject	See FreeFormObject.

---

ManifestAndResultResponse

The manifest plus (optionally) the persisted result.

Used as output by:

• DELETE /scan/{scan_id}

• GET /scan/{scan_id}

Fields:

Field	Type	Description
manifest	Manifest	See Manifest.
result	Result | object

---

Error

Used as output by:

• POST /scan/{scan_id}/actions/add-workers

Fields:

Field	Type	Description
error	string
reason	string
message	string

---

FreeFormObject

Open-ended JSON object (keys and values unrestricted). Used wherever the shape is owned by an external system or the requestor.

Used as input by:

• PATCH /scan/{scan_id}/manifest

• POST /scan

• POST /scans/find

Used as output by:

• GET /openapi.json

• GET /scan/{scan_id}/ewms/taskforces

• GET /scan/{scan_id}/ewms/workforce

• GET /scan/{scan_id}/i3-event

• GET /scan/{scan_id}/status

---

RealOrSimulatedEvent

Event-type classification. real* values map to real events; sim* to simulation.

Used as input by:

• POST /scan

---

LogUrlLink

A {url} wrapper pointing at a log endpoint. The URL is nullable while the log source is unavailable.

Used as output by:

• GET /scan/{scan_id}/logs

• GET /scan/{scan_id}/status

Fields:

Field	Type	Description
url	string | null

---

DataSize

Human-friendly size string (e.g. ‘1GB’, ‘512MB’) parseable by humanfriendly.parse_size, or raw integer bytes.

Used as input by:

• POST /scan

---

ManifestProjection

Fields to include in the returned manifest. Either “*” (all allowed fields) or an explicit array of field names. Omit the field entirely for the default (all fields, minus the disallowed ones on /scans/find). NOTE: under the legacy arghandler implementation, array values were silently broken (stringified via type=str); the OpenAPI-validated implementation is expected to accept both forms and normalize to a set server-side before the disallowed-fields check and dict_projection.

Used as input by:

• DELETE /scan/{scan_id}

• POST /scan

• POST /scan/{scan_id}/actions/rescan

• POST /scans/find

---

RequestClusters

Either a dict {cluster_location: n_workers} OR a list of [cluster_location, n_workers] 2-tuples. Use the list form to request the same cluster more than once.

Used as input by:

• POST /scan

---

ScannerServerEnvFromUser

User-provided env-vars injected into the scanner server k8s job. Scalar values only. Limits are intentionally looser than the classifier input shape because env-var values (URLs, PATHs, tokens, etc.) routinely exceed 25 chars.

Used as input by:

• POST /scan