Job CLI APIs

About XPRESSO Job CLI APIs

XPRESSO provides the following public CLI APIs to get or list Job information:

XPRESSO job get

• description: get a specific xpresso job info

• mandatory arguments:

  --name:

  • description: xpresso job name
  • usage: xpresso job get --name my_job

• optional arguments: no specific options supported; refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.

XPRESSO job list

• description: get a list of xpresso jobs and related info

• mandatory arguments: none

• optional arguments:

  --filter:

  • description: filtering jobs based on defined criteria (tags, name, owner, date_created)
  • usage: xpresso job list --filter tags=a,b,c name=my_job owner=chuck date_created=2019-03-22

  --limit:

  • description: limit the number of matching output
  • usage: xpresso job list --limit 10

--also refer to the Optional XPRESSO arguments for general arguments supported by all XPRESSO CLI APIs.