Jobs
run_job
{
"$defs": {
"DiskVolumeInput": {
"properties": {
"container_path": {
"title": "Container Path",
"type": "string"
},
"disk": {
"description": "Disk URI/reference",
"title": "Disk",
"type": "string"
},
"read_only": {
"default": false,
"title": "Read Only",
"type": "boolean"
}
},
"required": [
"disk",
"container_path"
],
"title": "DiskVolumeInput",
"type": "object"
},
"SecretFileInput": {
"properties": {
"container_path": {
"title": "Container Path",
"type": "string"
},
"secret": {
"description": "secret: reference only; never a secret value",
"title": "Secret",
"type": "string"
}
},
"required": [
"secret",
"container_path"
],
"title": "SecretFileInput",
"type": "object"
},
"StorageVolumeInput": {
"properties": {
"container_path": {
"title": "Container Path",
"type": "string"
},
"read_only": {
"default": false,
"title": "Read Only",
"type": "boolean"
},
"storage": {
"description": "Storage URI/reference, never a credential",
"title": "Storage",
"type": "string"
}
},
"required": [
"storage",
"container_path"
],
"title": "StorageVolumeInput",
"type": "object"
}
},
"properties": {
"cluster": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cluster"
},
"command": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Command"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Description"
},
"disk_volumes": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/DiskVolumeInput"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Disk Volumes"
},
"energy_schedule": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Energy Schedule"
},
"entrypoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Entrypoint"
},
"env": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Env"
},
"http_auth": {
"default": true,
"title": "Http Auth",
"type": "boolean"
},
"http_port": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Http Port"
},
"image": {
"title": "Image",
"type": "string"
},
"life_span_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Life Span Seconds"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"org": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Org"
},
"preset": {
"title": "Preset",
"type": "string"
},
"priority": {
"anyOf": [
{
"enum": [
"low",
"normal",
"high"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Priority"
},
"project": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project"
},
"restart_policy": {
"default": "never",
"enum": [
"never",
"on-failure",
"always"
],
"title": "Restart Policy",
"type": "string"
},
"schedule_timeout_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Schedule Timeout Seconds"
},
"scheduler_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Scheduler Enabled"
},
"secret_env": {
"anyOf": [
{
"additionalProperties": {
"type": "string"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Secret Env"
},
"secret_files": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/SecretFileInput"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Secret Files"
},
"storage_volumes": {
"anyOf": [
{
"items": {
"$ref": "#/$defs/StorageVolumeInput"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Storage Volumes"
},
"tags": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
},
"wait_for_jobs_quota": {
"default": false,
"title": "Wait For Jobs Quota",
"type": "boolean"
},
"workdir": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Workdir"
}
},
"required": [
"image",
"preset"
],
"title": "run_jobArguments",
"type": "object"
}list_jobs
get_job
exec_job
start_job_port_forward
list_job_port_forwards
stop_job_port_forward
wait_for_job
get_job_logs
get_job_telemetry
bump_job_life_span
send_job_signal
save_job_image
kill_job
Last updated
Was this helpful?