Create

Last updated 1 month ago

Was this helpful?

Create a new job

post

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.

dataSourceobjectOptional

Configuration for the data source providing input data to the job.

dataDestinationobjectOptional

Configuration for the data destination where job output will be sent.

paramsobjectOptional

Job-specific configuration parameters for the distributed application.

configobjectOptional

Job execution preferences.

Responses

objectOptional

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-04-19T02:25:18.227Z",
    "submittedAt": "2025-04-19T02:25:18.227Z",
    "startedAt": "2025-04-19T02:25:18.227Z",
    "endedAt": "2025-04-19T02:25:18.227Z",
    "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-04-19T02:25:18.227Z",
    "createdAt": "2025-04-19T02:25:18.227Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-04-19T02:25:18.227Z"
    },
    "appId": "text"
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}