AIT REST API

GET /

Return index page

GET /events

Endpoint that pushes Server-Sent Events to client

POST /events

Add an event to the event stream

JSON Parameters:
 
  • name – The name of the event to add.
  • data – The data to include with the event.
GET /evr/dict

Return JSON EVR dictionary

POST /messages

Log a message via core library logging utilities

JSON Parameters:
 
  • severity – The log message severity
  • message – The message to be sent
GET /messages

Endpoint that pushes syslog output to client

GET /tlm/dict

Return JSON Telemetry dictionary

Example Response:

GET /cmd/dict

Return JSON Command dictionary

Example Response:

GET /cmd/hist.json

Return sent command history

Example Response:

If you set the detailed query string flag the JSON returned will include timestamp information.

Example Detailed Response

POST /cmd

Send a given command

Form Parameters:
 
  • command – The command that should be sent. If arguments are to be included they should be separated via whitespace.

Example command format

POST /cmd/validate
GET /log

Endpoint that pushes syslog output to client

GET /tlm/realtime/openmct

Return telemetry packets in realtime to client

GET /tlm/realtime

Return telemetry packets in realtime to client

POST /tlm/query
GET /data

Expose ait.config.data info to the frontend

GET /leapseconds

Return UTC-GPS Leapsecond data

Example Response:

GET /seq

Return a JSON array of filenames in the SEQRoot directory

Example Response:

POST /seq

Run requested sequence file

Form Parameters:
 
  • seqfile – The sequence filename located in SEQRoot to execute
POST /seq/abort

Abort the active running sequence

GET /scripts

Return a JSON array of script filenames

Scripts are located via the script.directory configuration parameter.

GET /scripts/load/(name)

Return the text of a script

Scripts are located via the script.directory configuration parameter.

Parameters:
  • name – The name of the script to load. Should be one of the values returned by /scripts.
Status Codes:

Example Response:

POST /script/run

Run a script

Scripts are located via the script.directory configuration parameter.

Form Parameters:
 
  • scriptPath – The name of the script to load. This should be one of the values returned by /scripts.
Status Codes:
PUT /script/run

Resume a paused script

PUT /script/pause

Pause a running script

PUT /script/step

Step a paused script

DELETE /script/abort

Abort a running script

GET /limits/dict
POST /prompt
POST /prompt/response