Skip to main content
POST
Start an HPC Job

Authorizations

X-Domino-Api-Key
string
header
required

Body

application/json

Request to start an HPC (Slurm) Job. The Slurm partition is resolved automatically based on the project and is not accepted as input.

dataPlaneId
string
required

Id of the data-plane the HPC Job should run on.

Example:

"000000000000000000000000"

filePath
string
required

Path to the Slurm script file within the project, relative to the project root.

Example:

"scripts/hello.sh"

projectId
string
required

Id of project to create the HPC Job in.

Example:

"6a17175ab03cb818f0f9c25f"

config
object

Optional. Compute resource configuration for the HPC Job.

mainRepoGitRef
object
title
string

Name of the HPC Job to start.

Example:

"my-slurm-job"

Response

Accepted - the HPC Job was created and queued.