Manage

PreviousUpdate NextOther

Last updated 1 month ago

Was this helpful?

Stop a running job

post

Abort running job (an incomplete job that is yet to start will be deleted)

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Responses

objectOptional

post

POST /v1/customer/jobs/{jobId}/abort HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

Delete a job

delete

Delete a job

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Responses

objectOptional

delete

DELETE /v1/customer/jobs/{jobId} HTTP/1.1
Host: api.bytenite.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}

Run a job

post

Run a job

Authorizations

Path parameters

jobIdanyRequired

The id associated with your job.

Body

configobjectOptional

Job execution preferences.

Responses

objectOptional

post

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

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

{
  "ok": true,
  "requestId": "text",
  "message": "text",
  "error": {
    "code": 1,
    "message": "text",
    "description": "text"
  }
}