API docs by Redocly

SlideRule Runner API (v5.4.3)

Download OpenAPI specification:

License: BSD 3-Clause

API for submitting, monitoring, and canceling SlideRule batch processing jobs. All endpoints require JWT authentication and request signature verification.

Submit a batch runner job

Submits a Lua script with a list of arguments to be executed as individual AWS Batch jobs. Each element of args becomes a separate job invocation.

Authorizations:
OAuth2
header Parameters
X-Sliderule-Timestamp
required
string

Unix timestamp (seconds since epoch) of when the request was signed.

X-Sliderule-Signature
required
string

Base64-encoded signature of the canonical request string.

Request Body schema: application/json
required
name
required
string

Human-readable name for the job.

script
required
string <byte>

Base64-encoded Lua script to execute.

args
required
Array of strings

List of argument strings; each element becomes a separate batch job.

vcpus
integer [ 1 .. 8 ]

Optional vCPU override per job container.

memory
integer [ 4096 .. 32768 ]

Optional memory (MB) override per job container.

Responses

Request samples

Content type
application/json
{
  • "name": "my-processing-job",
  • "script": "string",
  • "args": [
    ],
  • "vcpus": 1,
  • "memory": 4096
}

Response samples

Content type
application/json
{
  • "name": "string",
  • "run_url": "s3://sliderule-public/stack-name/run-user-name-abc1234567",
  • "job_ids": [
    ]
}

Get status report on batch runner jobs

Returns detailed status information for a list of job IDs (up to 100).

Authorizations:
OAuth2
header Parameters
X-Sliderule-Timestamp
required
string

Unix timestamp (seconds since epoch) of when the request was signed.

X-Sliderule-Signature
required
string

Base64-encoded signature of the canonical request string.

Request Body schema: application/json
required
job_list
required
Array of strings <= 100 items

List of AWS Batch job IDs to query.

Responses

Request samples

Content type
application/json
{
  • "job_list": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get report on all jobs in the queue

Returns a summary count and list of jobs for the specified job state(s).

Authorizations:
OAuth2
header Parameters
X-Sliderule-Timestamp
required
string

Unix timestamp (seconds since epoch) of when the request was signed.

X-Sliderule-Signature
required
string

Base64-encoded signature of the canonical request string.

Request Body schema: application/json
required
required
string or Array of strings

One or more job states to query.

name
string

Only jobs with the provided name are reported.

job_id
string

Parent job id for a batch array job processing request. When supplied, only child jobs of this parent job id are returned. Note, the name parameter, if supplied, is still applied as a filter; so it is recommended that when job_id is supplied, name is omitted.

verbose
boolean
Default: false

When set to true the response will include a description of each job.

Responses

Request samples

Content type
application/json
{
  • "job_state": "SUBMITTED",
  • "name": "my-processing-job",
  • "job_id": "23e58402-c585-4865-8e36-ad0504aa205e",
  • "verbose": true
}

Response samples

Content type
application/json
{
  • "report": {
    },
  • "jobs": [
    ]
}

Cancel submitted jobs

Cancels specific jobs by ID, or all active jobs if no job_list is provided.

Authorizations:
OAuth2
header Parameters
X-Sliderule-Timestamp
required
string

Unix timestamp (seconds since epoch) of when the request was signed.

X-Sliderule-Signature
required
string

Base64-encoded signature of the canonical request string.

Request Body schema: application/json
required
job_list
Array of strings

List of job IDs to cancel. If omitted, all active jobs (SUBMITTED, PENDING, RUNNABLE, STARTING, RUNNING) will be canceled.

name
string

The name associated with the jobs that should be cancelled. Only used if job_list is not supplied.

Responses

Request samples

Content type
application/json
{
  • "job_list": [
    ],
  • "name": "my-processing-job"
}

Response samples

Content type
application/json
[
  • "string"
]