Create
Create a new computing job on ByteNite.
Authorizations
Body
If job id already exists and the request hasn't started the job record is updated, if job id is null a new id is generated.
jobIdstringOptional
Unique identifier for the job, automatically generated if left blank.
namestringOptional
Mnemonic name for the job.
templateIdstringRequired
Identifier of the application template used for this job.
descriptionstringOptional
Textual description of the job.
Responses
200
A successful response.
400
Returned when the users sends a malformed request.
401
Returned when the user is not authenticated.
403
Returned when the user does not have permission to access the resource.
404
Returned when the resource does not exist.
500
Returned when an error on the server occurred.
503
Returned when the resource is temporarily unavailable.
default
An unexpected error response.
post
POST /v1/customer/jobs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55
{
"name": "My job",
"templateId": "[email protected]"
}
{
"job": {
"id": "text",
"templateId": "text",
"name": "text",
"config": {
"taskTimeout": 1,
"jobTimeout": 1,
"isTestJob": true
},
"priority": "EXECUTION_PRIORITY_UNDEFINED",
"startAt": "2025-06-24T20:44:12.548Z",
"submittedAt": "2025-06-24T20:44:12.548Z",
"startedAt": "2025-06-24T20:44:12.548Z",
"endedAt": "2025-06-24T20:44:12.548Z",
"regions": {
"blacklist": [
"text"
],
"whitelist": [
"text"
]
},
"state": "JOB_STATE_NEW",
"dataSource": {
"dataSourceDescriptor": "s3",
"params": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"params": {
"preset": "text",
"partitioner": {},
"assembler": {},
"app": {}
},
"dataDestination": {
"dataSourceDescriptor": "s3",
"params": {
"@type": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"duration": 1,
"deletedAt": "2025-06-24T20:44:12.548Z",
"createdAt": "2025-06-24T20:44:12.548Z",
"paymentAmount": 1,
"numUnitsEstimation": "text",
"numChunks": 1,
"errorMessage": "text",
"description": "text",
"stateTimestamps": {
"ANY_ADDITIONAL_PROPERTY": "2025-06-24T20:44:12.548Z"
},
"appId": "text"
},
"templateInfo": {
"id": "text",
"owner": "text",
"description": "text",
"app": "text",
"partitioner": "text",
"assembler": "text"
}
}
Last updated
Was this helpful?