Start a Job

curl --request POST \
  --url https://mycluster.domino.tech/api/jobs/v1/jobs \
  --header 'Content-Type: application/json' \
  --header 'X-Domino-Api-Key: <api-key>' \
  --data '
{
  "projectId": "623130ad7a0af0281c01a698",
  "runCommand": "main.py",
  "capacityType": "on-demand",
  "commitId": "960a4c99a4cc38194cbacbcce41caa68ba5369ea",
  "environmentId": "623131507a0af0281c01a699",
  "environmentRevisionSpec": "ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)",
  "externalVolumeMountIds": [
    "6231327c7a0af0281c01a69b",
    "623132867a0af0281c01a69c"
  ],
  "hardwareTier": "small-k8s",
  "netAppVolumeIds": [
    "31c4a22a-5571-4e9b-b7ac-921d241acd00",
    "31c4a22a-5571-4e9b-b7ac-921d241acd01"
  ],
  "snapshotDatasetsOnCompletion": true,
  "snapshotNetAppVolumesOnCompletion": true,
  "title": "K-means clustering"
}
'

import requests

url = "https://mycluster.domino.tech/api/jobs/v1/jobs"

payload = {
    "projectId": "623130ad7a0af0281c01a698",
    "runCommand": "main.py",
    "capacityType": "on-demand",
    "commitId": "960a4c99a4cc38194cbacbcce41caa68ba5369ea",
    "environmentId": "623131507a0af0281c01a699",
    "environmentRevisionSpec": "ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)",
    "externalVolumeMountIds": ["6231327c7a0af0281c01a69b", "623132867a0af0281c01a69c"],
    "hardwareTier": "small-k8s",
    "netAppVolumeIds": ["31c4a22a-5571-4e9b-b7ac-921d241acd00", "31c4a22a-5571-4e9b-b7ac-921d241acd01"],
    "snapshotDatasetsOnCompletion": True,
    "snapshotNetAppVolumesOnCompletion": True,
    "title": "K-means clustering"
}
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({
    projectId: '623130ad7a0af0281c01a698',
    runCommand: 'main.py',
    capacityType: 'on-demand',
    commitId: '960a4c99a4cc38194cbacbcce41caa68ba5369ea',
    environmentId: '623131507a0af0281c01a699',
    environmentRevisionSpec: 'ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)',
    externalVolumeMountIds: ['6231327c7a0af0281c01a69b', '623132867a0af0281c01a69c'],
    hardwareTier: 'small-k8s',
    netAppVolumeIds: ['31c4a22a-5571-4e9b-b7ac-921d241acd00', '31c4a22a-5571-4e9b-b7ac-921d241acd01'],
    snapshotDatasetsOnCompletion: true,
    snapshotNetAppVolumesOnCompletion: true,
    title: 'K-means clustering'
  })
};

fetch('https://mycluster.domino.tech/api/jobs/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/jobs/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([
    'projectId' => '623130ad7a0af0281c01a698',
    'runCommand' => 'main.py',
    'capacityType' => 'on-demand',
    'commitId' => '960a4c99a4cc38194cbacbcce41caa68ba5369ea',
    'environmentId' => '623131507a0af0281c01a699',
    'environmentRevisionSpec' => 'ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)',
    'externalVolumeMountIds' => [
        '6231327c7a0af0281c01a69b',
        '623132867a0af0281c01a69c'
    ],
    'hardwareTier' => 'small-k8s',
    'netAppVolumeIds' => [
        '31c4a22a-5571-4e9b-b7ac-921d241acd00',
        '31c4a22a-5571-4e9b-b7ac-921d241acd01'
    ],
    'snapshotDatasetsOnCompletion' => true,
    'snapshotNetAppVolumesOnCompletion' => true,
    'title' => 'K-means clustering'
  ]),
  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/jobs/v1/jobs"

	payload := strings.NewReader("{\n  \"projectId\": \"623130ad7a0af0281c01a698\",\n  \"runCommand\": \"main.py\",\n  \"capacityType\": \"on-demand\",\n  \"commitId\": \"960a4c99a4cc38194cbacbcce41caa68ba5369ea\",\n  \"environmentId\": \"623131507a0af0281c01a699\",\n  \"environmentRevisionSpec\": \"ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)\",\n  \"externalVolumeMountIds\": [\n    \"6231327c7a0af0281c01a69b\",\n    \"623132867a0af0281c01a69c\"\n  ],\n  \"hardwareTier\": \"small-k8s\",\n  \"netAppVolumeIds\": [\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd00\",\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd01\"\n  ],\n  \"snapshotDatasetsOnCompletion\": true,\n  \"snapshotNetAppVolumesOnCompletion\": true,\n  \"title\": \"K-means clustering\"\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/jobs/v1/jobs")
  .header("X-Domino-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"projectId\": \"623130ad7a0af0281c01a698\",\n  \"runCommand\": \"main.py\",\n  \"capacityType\": \"on-demand\",\n  \"commitId\": \"960a4c99a4cc38194cbacbcce41caa68ba5369ea\",\n  \"environmentId\": \"623131507a0af0281c01a699\",\n  \"environmentRevisionSpec\": \"ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)\",\n  \"externalVolumeMountIds\": [\n    \"6231327c7a0af0281c01a69b\",\n    \"623132867a0af0281c01a69c\"\n  ],\n  \"hardwareTier\": \"small-k8s\",\n  \"netAppVolumeIds\": [\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd00\",\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd01\"\n  ],\n  \"snapshotDatasetsOnCompletion\": true,\n  \"snapshotNetAppVolumesOnCompletion\": true,\n  \"title\": \"K-means clustering\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://mycluster.domino.tech/api/jobs/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  \"projectId\": \"623130ad7a0af0281c01a698\",\n  \"runCommand\": \"main.py\",\n  \"capacityType\": \"on-demand\",\n  \"commitId\": \"960a4c99a4cc38194cbacbcce41caa68ba5369ea\",\n  \"environmentId\": \"623131507a0af0281c01a699\",\n  \"environmentRevisionSpec\": \"ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)\",\n  \"externalVolumeMountIds\": [\n    \"6231327c7a0af0281c01a69b\",\n    \"623132867a0af0281c01a69c\"\n  ],\n  \"hardwareTier\": \"small-k8s\",\n  \"netAppVolumeIds\": [\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd00\",\n    \"31c4a22a-5571-4e9b-b7ac-921d241acd01\"\n  ],\n  \"snapshotDatasetsOnCompletion\": true,\n  \"snapshotNetAppVolumesOnCompletion\": true,\n  \"title\": \"K-means clustering\"\n}"

response = http.request(request)
puts response.read_body

{
  "job": {
    "commentsCount": 123,
    "commitDetails": {
      "inputCommitId": "f1dafe322c7d4a6720f652c330fe33b014720e46",
      "outputCommitId": "e1f06e5f64cfc26c2b70e405f70b7c8300d8a4ed"
    },
    "datasetMounts": [
      {
        "datasetName": "MyDataset",
        "id": "623137f57a0af0281c01a6a0",
        "isInput": true,
        "projectId": "6231383c7a0af0281c01a6a1",
        "containerPath": "/domino/datasets/local/quick-start",
        "snapshotId": "623138807a0af0281c01a6a2",
        "snapshotVersion": 2
      }
    ],
    "dominoStats": [
      {
        "name": "R-squared",
        "value": 0.89
      }
    ],
    "externalVolumeMounts": [
      {
        "mountPath": "/path/to/my/volume",
        "name": "MyExternalVolume",
        "readOnly": false,
        "subPath": "/mypath"
      }
    ],
    "gitRepos": [
      {
        "id": "6231365e7a0af0281c01a69f",
        "name": "MyRepo",
        "ref": "<string>",
        "serviceProvider": "bitbucket",
        "uri": "git@github.com:apache/spark.git",
        "endingBranch": "final-branch",
        "endingCommitId": "dff155c9a736f9cd230eac420e3c1ef3daa0ad7e",
        "startingBranch": "init-test-branch",
        "startingCommitId": "4f2d5c2f54db4fbb16a093d4fb11fdb1fe0794c7"
      }
    ],
    "goalIds": [
      "<string>"
    ],
    "id": "<string>",
    "netAppVolumeMounts": [
      {
        "name": "MyVolume",
        "snapshotMountPath": "/path/to/my/snapshot",
        "snapshotReadOnly": false,
        "volumeMountPath": "/path/to/my/volume",
        "volumeReadOnly": false,
        "otherMounts": [
          {
            "mountPath": "/path/to/other/mount",
            "readOnly": true,
            "subPath": "/other/subPath"
          }
        ],
        "snapshotSubPath": "/my/snapshot/subPath",
        "volumeSubPath": "/my/volume/subPath"
      }
    ],
    "number": 123,
    "projects": [
      {
        "commitId": "7f8e3908f129c0ca6529028618e6f10b3d2f315a",
        "projectId": "623138c87a0af0281c01a6a3"
      }
    ],
    "runCommand": "<string>",
    "stageTimes": {
      "submissionTime": "2022-03-12T02:13:44.467Z",
      "completedTime": "2022-03-12T02:16:43.127Z",
      "startTime": "2022-03-12T02:15:44.848Z"
    },
    "status": {
      "executionStatus": "Succeeded",
      "isArchived": false,
      "isCompleted": true,
      "isScheduled": false
    },
    "tags": [
      {
        "createdAt": "2022-03-15T21:48:36.586Z",
        "creatorId": "6231342b7a0af0281c01a69e",
        "id": "623133e87a0af0281c01a69d",
        "name": "KMeansTest"
      }
    ],
    "computeCluster": {
      "clusterType": "dask",
      "computeEnvironmentId": "623139857a0af0281c01a6a4",
      "workerCount": 4,
      "workerHardwareTier": "large-k8s",
      "computeEnvironmentRevisionSpec": "ActiveRevision | LatestRevision | SomeRevision(623131577a0af0281c01a69a)",
      "masterHardwareTierId": "medium-k8s",
      "maxWorkerCount": 10,
      "workerStorageMB": 5
    },
    "mainRepoGitRef": {
      "refType": "head | commitId | tags | branches",
      "value": "my-test-branch"
    },
    "queuedJobStatusDetails": {
      "expectedWait": "Now",
      "explanation": "Your run has been assigned to a machine",
      "helpText": "It will start being prepared for execution momentarily"
    },
    "runLauncherId": "<string>",
    "startedById": "<string>",
    "title": "<string>",
    "usage": {
      "cpuPercentage": 5,
      "memoryGiB": 0.73
    }
  },
  "metadata": {
    "notices": [
      "<string>"
    ],
    "requestId": "<string>"
  }
}

{
  "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>"
}

{
  "error": "<string>"
}