Create job preset

curl --request POST \
  --url https://api.example.com/api/v1/job-presets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parameters": "<unknown>"
}
'

import requests

url = "https://api.example.com/api/v1/job-presets/"

payload = {
    "label": "<string>",
    "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parameters": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    device_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parameters: '<unknown>'
  })
};

fetch('https://api.example.com/api/v1/job-presets/', 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://api.example.com/api/v1/job-presets/",
  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([
    'label' => '<string>',
    'device_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parameters' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/api/v1/job-presets/"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/api/v1/job-presets/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/job-presets/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_username": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "temporal_workflow_name": "EnrollmentWorkflow",
  "label": "<string>",
  "is_default": true,
  "nscale_preset": true,
  "qualifying": true,
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": 123,
  "parameters": "<unknown>"
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

POST

api

job-presets

Create job preset

curl --request POST \
  --url https://api.example.com/api/v1/job-presets/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parameters": "<unknown>"
}
'

import requests

url = "https://api.example.com/api/v1/job-presets/"

payload = {
    "label": "<string>",
    "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "parameters": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    label: '<string>',
    device_type: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    parameters: '<unknown>'
  })
};

fetch('https://api.example.com/api/v1/job-presets/', 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://api.example.com/api/v1/job-presets/",
  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([
    'label' => '<string>',
    'device_type' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'parameters' => '<unknown>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/api/v1/job-presets/"

	payload := strings.NewReader("{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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://api.example.com/api/v1/job-presets/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/job-presets/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"label\": \"<string>\",\n  \"device_type\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"parameters\": \"<unknown>\"\n}"

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

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_username": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "temporal_workflow_name": "EnrollmentWorkflow",
  "label": "<string>",
  "is_default": true,
  "nscale_preset": true,
  "qualifying": true,
  "device_type": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": 123,
  "parameters": "<unknown>"
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

{
  "detail": "<string>",
  "code": "error",
  "field_errors": [
    {
      "field": "<string>",
      "messages": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

Serializer for JobPreset model.

temporal_workflow_name

enum<string>

required

EnrollmentWorkflow - Enrollment Workflow
SingleNodeBurnInWorkflow - Single Node Burn-In Workflow
MultiNodeBurnInPairwiseWorkflow - Multi-Node Burn-In Pairwise Workflow
MultiNodeBurnInCollectiveWorkflow - Multi-Node Burn-In Collective Workflow
PrepareHardwareTestImagesWorkflow - Prepare Hardware-Test Images Workflow
ReportGenerationWorkflow - Report Generation Workflow
SlurmAdoptWorkflow - Add to Test Cluster Workflow
SlurmReleaseWorkflow - Release from Test Cluster Workflow
CustomerReleaseWorkflow - Customer Release Workflow
IronicNodeCleanWorkflow - Ironic Node Clean Workflow
QuarantineWorkflow - Quarantine Workflow
ReleaseWorkflow - Release Workflow
UnenrollmentWorkflow - Unenrollment Workflow
ConnectivityVerificationWorkflow - Connectivity Verification Workflow
FirmwareInventoryWorkflow - Firmware Inventory Workflow
FirmwareVerificationWorkflow - Firmware Verification Workflow
FirmwarePolicyVerificationWorkflow - Firmware Policy Verification Workflow
NVSwitchFirmwarePolicyVerificationWorkflow - NVSwitch Firmware Policy Verification Workflow
NodeSwapWorkflow - Node Swap Workflow
PowerCycleWorkflow - Power Cycle Workflow
PowerOffWorkflow - Power Off Workflow
SetMaintenanceModeWorkflow - Set Maintenance Mode Workflow
DisableMaintenanceModeWorkflow - Disable Maintenance Mode Workflow
ColdResetBmcWorkflow - Cold Reset BMC Workflow
SlurmDrainNodeWorkflow - Slurm Drain Node Workflow
SlurmResumeNodeWorkflow - Slurm Resume Drained Node Workflow
FrontendVrfReturnWorkflow - Frontend VRF Return Workflow
FrontendVrfIsolateWorkflow - Frontend VRF Isolate Workflow
NvLinkIsolateWorkflow - NVLink Isolate Workflow
NvLinkReturnWorkflow - NVLink Return Workflow
BackendVrfIsolateWorkflow - Back-end VRF Isolate Workflow
BackendVrfReturnWorkflow - Back-end VRF Return Workflow
ImageNodeWorkflow - Image Node Workflow
UnimageNodeWorkflow - Unimage Node Workflow
NodeDiagnosticsWorkflow - Node Diagnostics Workflow

Available options:

EnrollmentWorkflow,

SingleNodeBurnInWorkflow,

MultiNodeBurnInPairwiseWorkflow,

MultiNodeBurnInCollectiveWorkflow,

PrepareHardwareTestImagesWorkflow,

ReportGenerationWorkflow,

SlurmAdoptWorkflow,

SlurmReleaseWorkflow,

CustomerReleaseWorkflow,

IronicNodeCleanWorkflow,

QuarantineWorkflow,

ReleaseWorkflow,

UnenrollmentWorkflow,

ConnectivityVerificationWorkflow,

FirmwareInventoryWorkflow,

FirmwareVerificationWorkflow,

FirmwarePolicyVerificationWorkflow,

NVSwitchFirmwarePolicyVerificationWorkflow,

NodeSwapWorkflow,

PowerCycleWorkflow,

PowerOffWorkflow,

SetMaintenanceModeWorkflow,

DisableMaintenanceModeWorkflow,

ColdResetBmcWorkflow,

SlurmDrainNodeWorkflow,

SlurmResumeNodeWorkflow,

FrontendVrfReturnWorkflow,

FrontendVrfIsolateWorkflow,

NvLinkIsolateWorkflow,

NvLinkReturnWorkflow,

BackendVrfIsolateWorkflow,

BackendVrfReturnWorkflow,

ImageNodeWorkflow,

UnimageNodeWorkflow,

NodeDiagnosticsWorkflow

label

string

required

Maximum string length: 255

device_type

string<uuid>

required

parameters

any

Response

Serializer for JobPreset model.

string<uuid>

required

read-only

created_by_username

string

required

read-only

created_at

string<date-time>

required

read-only

updated_at

string<date-time>

required

read-only

temporal_workflow_name

enum<string>

required

EnrollmentWorkflow - Enrollment Workflow
SingleNodeBurnInWorkflow - Single Node Burn-In Workflow
MultiNodeBurnInPairwiseWorkflow - Multi-Node Burn-In Pairwise Workflow
MultiNodeBurnInCollectiveWorkflow - Multi-Node Burn-In Collective Workflow
PrepareHardwareTestImagesWorkflow - Prepare Hardware-Test Images Workflow
ReportGenerationWorkflow - Report Generation Workflow
SlurmAdoptWorkflow - Add to Test Cluster Workflow
SlurmReleaseWorkflow - Release from Test Cluster Workflow
CustomerReleaseWorkflow - Customer Release Workflow
IronicNodeCleanWorkflow - Ironic Node Clean Workflow
QuarantineWorkflow - Quarantine Workflow
ReleaseWorkflow - Release Workflow
UnenrollmentWorkflow - Unenrollment Workflow
ConnectivityVerificationWorkflow - Connectivity Verification Workflow
FirmwareInventoryWorkflow - Firmware Inventory Workflow
FirmwareVerificationWorkflow - Firmware Verification Workflow
FirmwarePolicyVerificationWorkflow - Firmware Policy Verification Workflow
NVSwitchFirmwarePolicyVerificationWorkflow - NVSwitch Firmware Policy Verification Workflow
NodeSwapWorkflow - Node Swap Workflow
PowerCycleWorkflow - Power Cycle Workflow
PowerOffWorkflow - Power Off Workflow
SetMaintenanceModeWorkflow - Set Maintenance Mode Workflow
DisableMaintenanceModeWorkflow - Disable Maintenance Mode Workflow
ColdResetBmcWorkflow - Cold Reset BMC Workflow
SlurmDrainNodeWorkflow - Slurm Drain Node Workflow
SlurmResumeNodeWorkflow - Slurm Resume Drained Node Workflow
FrontendVrfReturnWorkflow - Frontend VRF Return Workflow
FrontendVrfIsolateWorkflow - Frontend VRF Isolate Workflow
NvLinkIsolateWorkflow - NVLink Isolate Workflow
NvLinkReturnWorkflow - NVLink Return Workflow
BackendVrfIsolateWorkflow - Back-end VRF Isolate Workflow
BackendVrfReturnWorkflow - Back-end VRF Return Workflow
ImageNodeWorkflow - Image Node Workflow
UnimageNodeWorkflow - Unimage Node Workflow
NodeDiagnosticsWorkflow - Node Diagnostics Workflow

Available options:

EnrollmentWorkflow,

SingleNodeBurnInWorkflow,

MultiNodeBurnInPairwiseWorkflow,

MultiNodeBurnInCollectiveWorkflow,

PrepareHardwareTestImagesWorkflow,

ReportGenerationWorkflow,

SlurmAdoptWorkflow,

SlurmReleaseWorkflow,

CustomerReleaseWorkflow,

IronicNodeCleanWorkflow,

QuarantineWorkflow,

ReleaseWorkflow,

UnenrollmentWorkflow,

ConnectivityVerificationWorkflow,

FirmwareInventoryWorkflow,

FirmwareVerificationWorkflow,

FirmwarePolicyVerificationWorkflow,

NVSwitchFirmwarePolicyVerificationWorkflow,

NodeSwapWorkflow,

PowerCycleWorkflow,

PowerOffWorkflow,

SetMaintenanceModeWorkflow,

DisableMaintenanceModeWorkflow,

ColdResetBmcWorkflow,

SlurmDrainNodeWorkflow,

SlurmResumeNodeWorkflow,

FrontendVrfReturnWorkflow,

FrontendVrfIsolateWorkflow,

NvLinkIsolateWorkflow,

NvLinkReturnWorkflow,

BackendVrfIsolateWorkflow,

BackendVrfReturnWorkflow,

ImageNodeWorkflow,

UnimageNodeWorkflow,

NodeDiagnosticsWorkflow

label

string

required

Maximum string length: 255

is_default

boolean

required

read-only

nscale_preset

boolean

required

read-only

True for presets seeded from YAML. These cannot be modified via the API.

qualifying

boolean

required

read-only

True for burn-in presets whose test coverage satisfies every active burn-in policy's qualifying requirements for the preset's resource class. Informational only (the verdict engine keys off TestExecution.execution_mode). Derived at seed time from the active burn-in policies; only True on burn-in-workflow presets (the field exists on every preset, defaulting to False).

device_type

string<uuid>

required

created_by

integer | null

required

read-only

parameters

any

Start Here

Operator Guide

Developer Guide

Relationships

Deployment Guide

Archived

API Reference

Create job preset

Authorizations

Body

Response