Update

---

Set a job datasource

patch

Set a job datasource

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

patch

/jobs/{jobId}/datasource

HTTPcURLJavaScriptPython

PATCH /v1/customer/jobs/{jobId}/datasource HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "dataSource": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  },
  "dataDestination": {
    "dataSourceDescriptor": "s3",
    "params": {
      "@type": "text",
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

application/jsonapplication/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-12-09T15:06:42.058Z",
    "submittedAt": "2025-12-09T15:06:42.058Z",
    "startedAt": "2025-12-09T15:06:42.058Z",
    "endedAt": "2025-12-09T15:06:42.058Z",
    "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-12-09T15:06:42.058Z",
    "createdAt": "2025-12-09T15:06:42.058Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-12-09T15:06:42.058Z"
    },
    "appId": "text",
    "templateInfo": {
      "id": "text",
      "owner": "text",
      "description": "text",
      "app": "text",
      "partitioner": "text",
      "assembler": "text"
    }
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

---

Set job parameters

patch

Set or update job specific parameters

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

presetstringOptional

[Deprecated] Preset configuration. This field is no longer in use.

partitionerobjectOptional

Sets parameters for the partitioning engine.

assemblerobjectOptional

Sets parameters for the assembling engine.

appobjectOptional

Sets parameters for the application..

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

patch

/jobs/{jobId}/params

HTTPcURLJavaScriptPython

PATCH /v1/customer/jobs/{jobId}/params HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "preset": "text",
  "partitioner": {},
  "assembler": {},
  "app": {}
}

application/jsonapplication/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-12-09T15:06:42.058Z",
    "submittedAt": "2025-12-09T15:06:42.058Z",
    "startedAt": "2025-12-09T15:06:42.058Z",
    "endedAt": "2025-12-09T15:06:42.058Z",
    "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-12-09T15:06:42.058Z",
    "createdAt": "2025-12-09T15:06:42.058Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-12-09T15:06:42.058Z"
    },
    "appId": "text",
    "templateInfo": {
      "id": "text",
      "owner": "text",
      "description": "text",
      "app": "text",
      "partitioner": "text",
      "assembler": "text"
    }
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

---

Set a job name

patch

Set a job name

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

stringOptionalExample: My Job

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

patch

/jobs/{jobId}/jobname

HTTPcURLJavaScriptPython

PATCH /v1/customer/jobs/{jobId}/jobname HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 8

"My Job"

application/jsonapplication/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-12-09T15:06:42.058Z",
    "submittedAt": "2025-12-09T15:06:42.058Z",
    "startedAt": "2025-12-09T15:06:42.058Z",
    "endedAt": "2025-12-09T15:06:42.058Z",
    "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-12-09T15:06:42.058Z",
    "createdAt": "2025-12-09T15:06:42.058Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-12-09T15:06:42.058Z"
    },
    "appId": "text",
    "templateInfo": {
      "id": "text",
      "owner": "text",
      "description": "text",
      "app": "text",
      "partitioner": "text",
      "assembler": "text"
    }
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}

---

Set job configs

patch

Set or update execution parameters/configurations

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Body

application/jsonapplication/x-protobuf

taskTimeoutinteger · int64Optional

jobTimeoutinteger · int64Optional

isTestJobbooleanOptional

Responses

200

A successful response.

application/jsonapplication/x-protobuf

400

Returned when the users sends a malformed request.

application/jsonapplication/x-protobuf

401

Returned when the user is not authenticated.

application/jsonapplication/x-protobuf

403

Returned when the user does not have permission to access the resource.

application/jsonapplication/x-protobuf

404

Returned when the resource does not exist.

application/jsonapplication/x-protobuf

500

Returned when an error on the server occurred.

application/jsonapplication/x-protobuf

503

Returned when the resource is temporarily unavailable.

application/jsonapplication/x-protobuf

default

An unexpected error response.

application/jsonapplication/x-protobuf

patch

/jobs/{jobId}/configs

HTTPcURLJavaScriptPython

PATCH /v1/customer/jobs/{jobId}/configs HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "taskTimeout": 1,
  "jobTimeout": 1,
  "isTestJob": true
}

application/jsonapplication/x-protobuf

{
  "job": {
    "id": "text",
    "templateId": "text",
    "name": "text",
    "config": {
      "taskTimeout": 1,
      "jobTimeout": 1,
      "isTestJob": true
    },
    "priority": "EXECUTION_PRIORITY_UNDEFINED",
    "startAt": "2025-12-09T15:06:42.058Z",
    "submittedAt": "2025-12-09T15:06:42.058Z",
    "startedAt": "2025-12-09T15:06:42.058Z",
    "endedAt": "2025-12-09T15:06:42.058Z",
    "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-12-09T15:06:42.058Z",
    "createdAt": "2025-12-09T15:06:42.058Z",
    "paymentAmount": 1,
    "numUnitsEstimation": "text",
    "numChunks": 1,
    "errorMessage": "text",
    "description": "text",
    "stateTimestamps": {
      "ANY_ADDITIONAL_PROPERTY": "2025-12-09T15:06:42.058Z"
    },
    "appId": "text",
    "templateInfo": {
      "id": "text",
      "owner": "text",
      "description": "text",
      "app": "text",
      "partitioner": "text",
      "assembler": "text"
    }
  },
  "templateInfo": {
    "id": "text",
    "owner": "text",
    "description": "text",
    "app": "text",
    "partitioner": "text",
    "assembler": "text"
  }
}