REST API reference
Every route the AARCV server exposes, generated from the application itself. 138 operations across 7 areas. Request and response bodies are JSON unless noted.
Authenticate with HTTP Basic over TLS. The Access column is the minimum role or named permission the server enforces; see Authentication and roles. Path parameters use the IDs returned by list calls (sortie IDs look like S-1A2B3C4D).
Sorties and debriefs#
Upload a recording, poll its status, fetch the assessment and its products, and record instructor reviews.
GET/api/agreementInstructor-agreement statistics against the 95% objective
Instructor-agreement statistics against the 95% objective. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/agreement"GET/api/export/package.zipDownload the evidence package for all sorties
Download the evidence package for all sorties. role: instructor or higher
| Parameter | In | Type | |
|---|---|---|---|
pilot | query | optional | |
since | query | optional |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/export/package.zip"GET/api/export/records.csvTraining records as CSV
Training records as CSV. role: instructor or higher
| Parameter | In | Type | |
|---|---|---|---|
pilot | query | optional | |
since | query | optional |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/export/records.csv"GET/api/export/xapiTraining records as xAPI statements
Training records as xAPI statements. role: instructor or higher
| Parameter | In | Type | |
|---|---|---|---|
pilot | query | optional | |
since | query | optional |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/export/xapi"GET/api/pilots/{pid}/trendA pilot's scores across sorties
A pilot's scores across sorties. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/pilots/$PID/trend"GET/api/reviews.csvAll instructor reviews as CSV training labels
All instructor reviews as CSV training labels. role: instructor or higher
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/reviews.csv"GET/api/sortiesList sorties the caller can see, with status and headline scores
List sorties the caller can see, with status and headline scores. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties"POST/api/sortiesUpload a recording (and optional telemetry) for processing
Upload a recording (and optional telemetry) for processing. role: instructor or higher
| Parameter | In | Type | |
|---|---|---|---|
video | form | required | string |
telemetry | form | optional | string | null |
pilot_id | form | optional | string |
declared_receiver | form | optional | string |
date | form | optional | string |
label | form | optional | string |
tail | form | optional | string |
camera_id | form | optional | string |
data_source | form | optional | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sorties"GET/api/sorties/{sid}Sortie status, metadata and the released assessment
Sortie status, metadata and the released assessment. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties/$SID"DELETE/api/sorties/{sid}Delete a sortie and its products
Delete a sortie and its products. role: admin or higher
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X DELETE "$AARCV_URL/api/sorties/$SID"GET/api/sorties/{sid}/commsRadio transcript aligned to the sortie timeline
Radio transcript aligned to the sortie timeline. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties/$SID/comms"POST/api/sorties/{sid}/commsAttach a radio recording or transcript
Attach a radio recording or transcript. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
file | form | required | string |
offset_s | form | optional | number |
callsigns | form | optional | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sorties/$SID/comms"POST/api/sorties/{sid}/comms/transcribeTranscribe the attached radio recording on-box
Transcribe the attached radio recording on-box. role: admin
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sorties/$SID/comms/transcribe"POST/api/sorties/{sid}/reviewRecord an instructor's confirm or override per category and event
Record an instructor's confirm or override per category and event. role: instructor or higher
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sorties/$SID/review"GET/api/sorties/{sid}/scene3D replay data: track, attitude, envelope and events
3D replay data: track, attitude, envelope and events. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties/$SID/scene"GET/sorties/{sid}/files/{name}Download a released product file (video, chart, report)
Download a released product file (video, chart, report). signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
name | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/sorties/$SID/files/$NAME"Video security and release#
Classification policy, per-sortie markings and redaction, release review, chain of custody and signed export packages.
GET/api/postureDeployment security posture checks (RMF evidence)
Deployment security posture checks (RMF evidence). role: admin or higher
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/posture"GET/api/security/accessUsers' clearances, networks and release access
Users' clearances, networks and release access. permission: security
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/access"PUT/api/security/access/{name}Set a user's clearance and network access
Set a user's clearance and network access. permission: security
| Parameter | In | Type | |
|---|---|---|---|
name | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/security/access/$NAME"POST/api/security/checkpointsWrite a signed checkpoint of the custody log
Write a signed checkpoint of the custody log. permission: security
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/security/checkpoints"GET/api/security/checkpoints/verifyVerify all custody checkpoints
Verify all custody checkpoints. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/checkpoints/verify"GET/api/security/marking/previewPreview the marking a recording would receive
Preview the marking a recording would receive. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
data_source | query | optional | string |
telemetry | query | optional | boolean |
pilot | query | optional | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/marking/preview"GET/api/security/policyActive classification policy
Active classification policy. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/policy"PUT/api/security/policyDraft a new classification policy version
Draft a new classification policy version. permission: security
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/security/policy"POST/api/security/policy/{vid}/activateActivate a classification policy version
Activate a classification policy version. permission: security
| Parameter | In | Type | |
|---|---|---|---|
vid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/security/policy/$VID/activate"GET/api/security/public-keyPublic key that verifies custody and package signatures
Public key that verifies custody and package signatures. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/public-key"GET/api/security/rolesRoles and what each may see and release
Roles and what each may see and release. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/roles"GET/api/security/sorties/{sid}Markings, frame screening and release state for one sortie
Markings, frame screening and release state for one sortie. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/sorties/$SID"GET/api/security/sorties/{sid}/custody.jsonSigned chain-of-custody record
Signed chain-of-custody record. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/sorties/$SID/custody.json"GET/api/security/sorties/{sid}/exportDownload a signed, verifiable release package
Download a signed, verifiable release package. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
network | query | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/sorties/$SID/export"POST/api/security/sorties/{sid}/products/{name}/reviewRelease or withhold one product after security review
Release or withhold one product after security review. permission: security
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
name | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/security/sorties/$SID/products/$NAME/review"POST/api/security/sorties/{sid}/redactRedact a time range or region and re-render the products
Redact a time range or region and re-render the products. permission: redact
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/security/sorties/$SID/redact"POST/api/security/sorties/{sid}/verifyRe-verify every product hash and signature
Re-verify every product hash and signature. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/security/sorties/$SID/verify"GET/api/security/summarySecurity posture: markings, review queue, redactions, custody
Security posture: markings, review queue, redactions, custody. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/security/summary"Training and proficiency#
Training plans and sign-offs, the portable proficiency record and simulator export.
GET/api/recordProficiency records held by this unit
Proficiency records held by this unit. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/record"POST/api/record/exportExport a signed, portable proficiency record
Export a signed, portable proficiency record. permission: aircrew
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/record/export"POST/api/record/importImport a proficiency record from another unit
Import a proficiency record from another unit. permission: aircrew
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/record/import"GET/api/record/keyThis unit's record-signing public key
This unit's record-signing public key. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/record/key"POST/api/record/linkLink an imported record to a local aircrew member
Link an imported record to a local aircrew member. permission: aircrew
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/record/link"GET/api/record/planCarry-over training plan from an imported record
Carry-over training plan from an imported record. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/record/plan"POST/api/record/trustTrust another unit's record-signing key
Trust another unit's record-signing key. permission: config
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/record/trust"POST/api/record/verifyVerify a proficiency record from another unit
Verify a proficiency record from another unit. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/record/verify"GET/api/sorties/{sid}/simlinkSimulator scenario built from the sortie
Simulator scenario built from the sortie. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
format | query | optional | string |
lat | query | optional | number |
lon | query | optional | number |
alt_m | query | optional | number |
heading_deg | query | optional | number |
tas_mps | query | optional | number |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties/$SID/simlink"GET/api/trainingTraining overview: plans, focus areas and currency
Training overview: plans, focus areas and currency. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/training"GET/api/training/catalogCatalog of drills and syllabus items
Catalog of drills and syllabus items. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/training/catalog"GET/api/training/{pid}A pilot's training plan, focus areas and sign-offs
A pilot's training plan, focus areas and sign-offs. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/training/$PID"GET/api/training/{pid}/exportExport a pilot's training plan
Export a pilot's training plan. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/training/$PID/export"POST/api/training/{pid}/plansCreate or update a pilot's training plan
Create or update a pilot's training plan. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/training/$PID/plans"POST/api/training/{pid}/signoffsRecord an instructor sign-off
Record an instructor sign-off. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/training/$PID/signoffs"Models and data#
Model registry, evaluation gates, staging, drift, datasets and rubric tuning.
GET/api/learningLearning loop status: queue, datasets and rounds
Learning loop status: queue, datasets and rounds. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/learning"POST/api/learning/datasetsFreeze a labelled dataset for training
Freeze a labelled dataset for training. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/learning/datasets"POST/api/learning/mineMine sorties for hard examples to label
Mine sorties for hard examples to label. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/learning/mine"POST/api/learning/queue/{qid}Accept, label or reject a queued example
Accept, label or reject a queued example. permission: aircrew
| Parameter | In | Type | |
|---|---|---|---|
qid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/learning/queue/$QID"POST/api/learning/roundsStart a retraining round
Start a retraining round. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/learning/rounds"GET/api/ops/datasetsList training datasets
List training datasets. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/datasets"POST/api/ops/datasetsCreate a training dataset
Create a training dataset. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/datasets"POST/api/ops/datasets/autoQueues sorties worth labelling: instructor disagreements, events marked invalid, weak tracking
Queues sorties worth labelling: instructor disagreements, events marked invalid, weak tracking. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/datasets/auto"GET/api/ops/datasets/manifest.jsonTraining-set manifest: sanitized products and labels only, never raw video
Training-set manifest: sanitized products and labels only, never raw video. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/datasets/manifest.json"PUT/api/ops/datasets/{did}Update a dataset's items or status
Update a dataset's items or status. permission: models
| Parameter | In | Type | |
|---|---|---|---|
did | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/datasets/$DID"GET/api/ops/driftDrift indicators per camera and fleet-wide
Drift indicators per camera and fleet-wide. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/drift"GET/api/ops/evaluations/{eid}One model evaluation run and its gate results
One model evaluation run and its gate results. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
eid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/evaluations/$EID"GET/api/ops/modelsModel registry: versions, stages and evaluation results
Model registry: versions, stages and evaluation results. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/models"POST/api/ops/modelsRegister a new model version
Register a new model version. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/models"POST/api/ops/models/{vid}/evaluateRun the evaluation gate on a model version
Run the evaluation gate on a model version. permission: models
| Parameter | In | Type | |
|---|---|---|---|
vid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/models/$VID/evaluate"POST/api/ops/models/{vid}/stagePromote, stage or roll back a model version
Promote, stage or roll back a model version. permission: models
| Parameter | In | Type | |
|---|---|---|---|
vid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/models/$VID/stage"GET/api/ops/tuningRubric tuning suggestions from instructor reviews
Rubric tuning suggestions from instructor reviews. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/tuning"POST/api/ops/tuning/registerRegister a tuned rubric as a configuration version
Register a tuned rubric as a configuration version. permission: models
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/tuning/register"Fleet, aircrew and maintenance#
Tankers, cameras, calibration and BIT, aircrew, work orders, damage reports and component health.
POST/api/ops/aircraftAdd a tanker
Add a tanker. permission: fleet
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/aircraft"PUT/api/ops/aircraft/{tail}Update a tanker
Update a tanker. permission: fleet
| Parameter | In | Type | |
|---|---|---|---|
tail | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/aircraft/$TAIL"GET/api/ops/aircrewAircrew roster and currency
Aircrew roster and currency. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/aircrew"POST/api/ops/aircrewAdd an aircrew member
Add an aircrew member. permission: aircrew
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/aircrew"PUT/api/ops/aircrew/{pid}Update an aircrew member
Update an aircrew member. permission: aircrew
| Parameter | In | Type | |
|---|---|---|---|
pid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/aircrew/$PID"POST/api/ops/camerasAdd a boom camera
Add a boom camera. permission: fleet
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/cameras"PUT/api/ops/cameras/{cid}Update a camera
Update a camera. permission: fleet
| Parameter | In | Type | |
|---|---|---|---|
cid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/cameras/$CID"POST/api/ops/cameras/{cid}/bitBuilt-in-test report from the camera or its maintainer: {"pass": bool, ...readings}
Built-in-test report from the camera or its maintainer: {"pass": bool, ...readings}. permission: fleet
| Parameter | In | Type | |
|---|---|---|---|
cid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/cameras/$CID/bit"POST/api/ops/cameras/{cid}/calibrateRecord a camera calibration
Record a camera calibration. permission: fleet
| Parameter | In | Type | |
|---|---|---|---|
cid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/cameras/$CID/calibrate"GET/api/ops/damageFleet damage exposure and public mishap costs
Fleet damage exposure and public mishap costs. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/damage"GET/api/ops/damage/reportsList damage reports
List damage reports. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/damage/reports"POST/api/ops/damage/reportsFile a damage report
File a damage report. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/damage/reports"DELETE/api/ops/damage/reports/{rid}Delete a damage report
Delete a damage report. permission: maintenance
| Parameter | In | Type | |
|---|---|---|---|
rid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X DELETE "$AARCV_URL/api/ops/damage/reports/$RID"GET/api/ops/damage/savingsDamage-avoidance savings estimate (low, base, high)
Damage-avoidance savings estimate (low, base, high). signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/damage/savings"GET/api/ops/work-ordersList maintenance work orders
List maintenance work orders. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/work-orders"POST/api/ops/work-ordersOpen a work order
Open a work order. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/work-orders"PUT/api/ops/work-orders/{wid}Update a work order
Update a work order. permission: maintenance
| Parameter | In | Type | |
|---|---|---|---|
wid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/work-orders/$WID"GET/api/prognosticsBoom and receptacle health across the fleet
Boom and receptacle health across the fleet. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/prognostics"POST/api/prognostics/actionsRecord a maintenance action on a component
Record a maintenance action on a component. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/prognostics/actions"POST/api/prognostics/flagsFlag a component for inspection
Flag a component for inspection. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/prognostics/flags"GET/api/prognostics/{component}/{asset_id}Load history and remaining-life estimate for one component
Load history and remaining-life estimate for one component. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
component | path | required | string |
asset_id | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/prognostics/$COMPONENT/$ASSET_ID"GET/api/sorties/{sid}/damageDamage exposure for each deviation in the sortie
Damage exposure for each deviation in the sortie. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sorties/$SID/damage"Sites, edge and fleet scale#
Multi-site capacity, the edge unit's store-and-forward outbox, receiver onboarding, the autonomy referee and coalition release.
POST/api/coalition/previewPreview what a coalition partner would receive
Preview what a coalition partner would receive. role: security_officer or admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/coalition/preview"GET/api/coalition/profilesList coalition release profiles
List coalition release profiles. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/coalition/profiles"POST/api/coalition/profilesCreate a coalition release profile
Create a coalition release profile. role: security_officer or admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/coalition/profiles"POST/api/coalition/releaseRelease a debrief to a coalition partner
Release a debrief to a coalition partner. role: security_officer or admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/coalition/release"GET/api/coalition/releasesList coalition releases
List coalition releases. role: security_officer or admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/coalition/releases"GET/api/coalition/stringsTranslated debrief strings for partner languages
Translated debrief strings for partner languages. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/coalition/strings"GET/api/edgeEdge unit status: profile, inbox and outbox
Edge unit status: profile, inbox and outbox. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/edge"POST/api/edge/benchRun the real-time-factor benchmark on this unit
Run the real-time-factor benchmark on this unit. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/edge/bench"POST/api/edge/inbox/offerOffer an item to the edge inbox
Offer an item to the edge inbox. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/edge/inbox/offer"PUT/api/edge/inbox/{item_id}/{idx}Accept or reject an inbox item
Accept or reject an inbox item. permission: maintenance
| Parameter | In | Type | |
|---|---|---|---|
item_id | path | required | string |
idx | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/edge/inbox/$ITEM_ID/$IDX"POST/api/edge/outboxQueue a product for store-and-forward
Queue a product for store-and-forward. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/edge/outbox"POST/api/edge/outbox/syncSync the outbox when a link is available
Sync the outbox when a link is available. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/edge/outbox/sync"PUT/api/edge/profileSet the edge unit's hardware profile
Set the edge unit's hardware profile. permission: maintenance
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/edge/profile"GET/api/fleetSites, units and job queues
Sites, units and job queues. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/fleet"GET/api/fleet/capacityCapacity plan: sorties per day per site
Capacity plan: sorties per day per site. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/fleet/capacity"GET/api/fleet/envelopeFleet-wide envelope cloud from every assessed sortie
Fleet-wide envelope cloud from every assessed sortie. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/fleet/envelope"POST/api/fleet/jobsQueue a processing job on a site
Queue a processing job on a site. role: admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/fleet/jobs"POST/api/fleet/sitesAdd a site
Add a site. role: admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/fleet/sites"POST/api/fleet/syncSync products and models between sites
Sync products and models between sites. role: admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/fleet/sync"POST/api/fleet/unitsAdd a processing unit to a site
Add a processing unit to a site. role: admin
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/fleet/units"GET/api/onboardingReceiver types and their qualification status
Receiver types and their qualification status. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/onboarding"GET/api/onboarding/runs/{run_id}One qualification run
One qualification run. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
run_id | path | required | integer |
format | query | optional | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/onboarding/runs/$RUN_ID"POST/api/onboarding/specsSubmit a new receiver type specification
Submit a new receiver type specification. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/onboarding/specs"GET/api/onboarding/{rid}One receiver type specification
One receiver type specification. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
rid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/onboarding/$RID"GET/api/onboarding/{rid}/planQualification plan for a receiver type
Qualification plan for a receiver type. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
rid | path | required | string |
lighting | query | optional | string |
weather | query | optional | string |
style | query | optional | string |
dev | query | optional | integer |
heldout | query | optional | integer |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/onboarding/$RID/plan"POST/api/onboarding/{rid}/qualifyRun qualification for a receiver type
Run qualification for a receiver type. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
rid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/onboarding/$RID/qualify"GET/api/referee/reportsList autonomy referee reports
List autonomy referee reports. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/referee/reports"GET/api/referee/reports/{rid}One autonomy referee report
One autonomy referee report. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
rid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/referee/reports/$RID"GET/api/referee/{sid}/datasetReferee dataset built from a sortie
Referee dataset built from a sortie. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/referee/$SID/dataset"POST/api/referee/{sid}/evaluateScore an automated-boom run against the rubric
Score an automated-boom run against the rubric. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
sid | path | required | string |
file | form | required | string |
system | form | optional | string |
offset_s | form | optional | number |
auto_offset | form | optional | boolean |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/referee/$SID/evaluate"GET/api/sanitizer/jobsList video sanitizer jobs
List video sanitizer jobs. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/jobs"POST/api/sanitizer/jobsSubmit a video to the standalone sanitizer
Submit a video to the standalone sanitizer. permission: redact
| Parameter | In | Type | |
|---|---|---|---|
video | form | required | string |
profile | form | required | string |
ranges | form | optional | string |
regions | form | optional | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sanitizer/jobs"GET/api/sanitizer/jobs/{jid}One sanitizer job
One sanitizer job. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
jid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/jobs/$JID"POST/api/sanitizer/jobs/{jid}/approveApprove a sanitized video for release
Approve a sanitized video for release. permission: security
| Parameter | In | Type | |
|---|---|---|---|
jid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sanitizer/jobs/$JID/approve"GET/api/sanitizer/jobs/{jid}/downloadDownload the sanitized video
Download the sanitized video. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
jid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/jobs/$JID/download"GET/api/sanitizer/jobs/{jid}/reportSanitization report for a job
Sanitization report for a job. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
jid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/jobs/$JID/report"GET/api/sanitizer/jobs/{jid}/verifyVerify a sanitized output's hashes and signature
Verify a sanitized output's hashes and signature. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
jid | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/jobs/$JID/verify"GET/api/sanitizer/profilesSanitizer profiles by domain
Sanitizer profiles by domain. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/sanitizer/profiles"POST/api/sanitizer/verifyVerify a sanitized file you hold
Verify a sanitized file you hold. signed-in user
| Parameter | In | Type | |
|---|---|---|---|
package | form | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/sanitizer/verify"Administration#
Users, configuration, allow-list, health and audit.
GET/api/audit/verifyVerify the hash chain of the audit log
Verify the hash chain of the audit log. role: admin or higher
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/audit/verify"PUT/api/ops/allowlistSet the receiver platform allow-list
Set the receiver platform allow-list. permission: config
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/allowlist"GET/api/ops/configConfiguration versions and the active one
Configuration versions and the active one. permission: config
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/config"POST/api/ops/configCreate a configuration version
Create a configuration version. permission: config
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/config"POST/api/ops/config/{cid}/activateActivate a configuration version
Activate a configuration version. permission: config
| Parameter | In | Type | |
|---|---|---|---|
cid | path | required | integer |
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/config/$CID/activate"GET/api/ops/healthSystem health: queue, disk, workers
System health: queue, disk, workers. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/health"GET/api/ops/summaryOperations overview counters
Operations overview counters. signed-in user
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/summary"GET/api/ops/usersList users
List users. permission: users
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" "$AARCV_URL/api/ops/users"POST/api/ops/usersCreate a user
Create a user. permission: users
No parameters.
curl -su "$AARCV_USER:$AARCV_PASS" -X POST "$AARCV_URL/api/ops/users"PUT/api/ops/users/{name}Update a user's role or password
Update a user's role or password. permission: users
| Parameter | In | Type | |
|---|---|---|---|
name | path | required | string |
curl -su "$AARCV_USER:$AARCV_PASS" -X PUT "$AARCV_URL/api/ops/users/$NAME"