Start an HPC Job
curl --request POST \
--url https://mycluster.domino.tech/api/hpc/v1/jobs \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"dataPlaneId": "000000000000000000000000",
"filePath": "scripts/hello.sh",
"projectId": "6a17175ab03cb818f0f9c25f",
"config": {
"cpu": 4,
"gpu": 1,
"memory": "8Gi",
"nodes": 1,
"ntasks": 1,
"walltime": "01:30:00"
},
"title": "my-slurm-job"
}
'import requests
url = "https://mycluster.domino.tech/api/hpc/v1/jobs"
payload = {
"dataPlaneId": "000000000000000000000000",
"filePath": "scripts/hello.sh",
"projectId": "6a17175ab03cb818f0f9c25f",
"config": {
"cpu": 4,
"gpu": 1,
"memory": "8Gi",
"nodes": 1,
"ntasks": 1,
"walltime": "01:30:00"
},
"title": "my-slurm-job"
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataPlaneId: '000000000000000000000000',
filePath: 'scripts/hello.sh',
projectId: '6a17175ab03cb818f0f9c25f',
config: {cpu: 4, gpu: 1, memory: '8Gi', nodes: 1, ntasks: 1, walltime: '01:30:00'},
title: 'my-slurm-job'
})
};
fetch('https://mycluster.domino.tech/api/hpc/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/hpc/v1/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataPlaneId' => '000000000000000000000000',
'filePath' => 'scripts/hello.sh',
'projectId' => '6a17175ab03cb818f0f9c25f',
'config' => [
'cpu' => 4,
'gpu' => 1,
'memory' => '8Gi',
'nodes' => 1,
'ntasks' => 1,
'walltime' => '01:30:00'
],
'title' => 'my-slurm-job'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/hpc/v1/jobs"
payload := strings.NewReader("{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mycluster.domino.tech/api/hpc/v1/jobs")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/hpc/v1/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource."
}{
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"error": "<string>"
}HPC Jobs
Start an HPC Job
Start a new HPC (Slurm) Job. Required permissions: StartJob, UseGlobalCompute
POST
/
api
/
hpc
/
v1
/
jobs
Start an HPC Job
curl --request POST \
--url https://mycluster.domino.tech/api/hpc/v1/jobs \
--header 'Content-Type: application/json' \
--header 'X-Domino-Api-Key: <api-key>' \
--data '
{
"dataPlaneId": "000000000000000000000000",
"filePath": "scripts/hello.sh",
"projectId": "6a17175ab03cb818f0f9c25f",
"config": {
"cpu": 4,
"gpu": 1,
"memory": "8Gi",
"nodes": 1,
"ntasks": 1,
"walltime": "01:30:00"
},
"title": "my-slurm-job"
}
'import requests
url = "https://mycluster.domino.tech/api/hpc/v1/jobs"
payload = {
"dataPlaneId": "000000000000000000000000",
"filePath": "scripts/hello.sh",
"projectId": "6a17175ab03cb818f0f9c25f",
"config": {
"cpu": 4,
"gpu": 1,
"memory": "8Gi",
"nodes": 1,
"ntasks": 1,
"walltime": "01:30:00"
},
"title": "my-slurm-job"
}
headers = {
"X-Domino-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Domino-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
dataPlaneId: '000000000000000000000000',
filePath: 'scripts/hello.sh',
projectId: '6a17175ab03cb818f0f9c25f',
config: {cpu: 4, gpu: 1, memory: '8Gi', nodes: 1, ntasks: 1, walltime: '01:30:00'},
title: 'my-slurm-job'
})
};
fetch('https://mycluster.domino.tech/api/hpc/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://mycluster.domino.tech/api/hpc/v1/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'dataPlaneId' => '000000000000000000000000',
'filePath' => 'scripts/hello.sh',
'projectId' => '6a17175ab03cb818f0f9c25f',
'config' => [
'cpu' => 4,
'gpu' => 1,
'memory' => '8Gi',
'nodes' => 1,
'ntasks' => 1,
'walltime' => '01:30:00'
],
'title' => 'my-slurm-job'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Domino-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://mycluster.domino.tech/api/hpc/v1/jobs"
payload := strings.NewReader("{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Domino-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://mycluster.domino.tech/api/hpc/v1/jobs")
.header("X-Domino-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mycluster.domino.tech/api/hpc/v1/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Domino-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"dataPlaneId\": \"000000000000000000000000\",\n \"filePath\": \"scripts/hello.sh\",\n \"projectId\": \"6a17175ab03cb818f0f9c25f\",\n \"config\": {\n \"cpu\": 4,\n \"gpu\": 1,\n \"memory\": \"8Gi\",\n \"nodes\": 1,\n \"ntasks\": 1,\n \"walltime\": \"01:30:00\"\n },\n \"title\": \"my-slurm-job\"\n}"
response = http.request(request)
puts response.read_body{
"error": "<string>"
}{
"code": "UNAUTHORIZED",
"message": "Authentication is required to access this resource."
}{
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action."
}{
"error": "<string>"
}Authorizations
nucleus_DominoApiKeynucleus_BearerAuthentication
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.
Id of the data-plane the HPC Job should run on.
Example:
"000000000000000000000000"
Path to the Slurm script file within the project, relative to the project root.
Example:
"scripts/hello.sh"
Id of project to create the HPC Job in.
Example:
"6a17175ab03cb818f0f9c25f"
Optional. Compute resource configuration for the HPC Job.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Name of the HPC Job to start.
Example:
"my-slurm-job"
Response
Accepted - the HPC Job was created and queued.
Was this page helpful?
⌘I