Manage

Run a job

post

Run a job

Authorizations

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Body

Responses

200

A successful response.

okbooleanOptional

True if the request was successful.

requestIdstringOptional

Internal request identifier for tracing or support.

Example: xyz-123

messagestringOptional

Additional message providing status or context.

Example: Request failed

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

/jobs/{jobId}/run

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": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}

Stop a running job

post

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

Authorizations

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Responses

200

A successful response.

okbooleanOptional

True if the request was successful.

requestIdstringOptional

Internal request identifier for tracing or support.

Example: xyz-123

messagestringOptional

Additional message providing status or context.

Example: Request failed

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

/jobs/{jobId}/abort

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

{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}

Delete a job

delete

Delete a job

Authorizations

AuthorizationstringRequired

Your ByteNite access token

Path parameters

jobIdstringRequired

The id associated with your job.

Responses

200

A successful response.

okbooleanOptional

True if the request was successful.

requestIdstringOptional

Internal request identifier for tracing or support.

Example: xyz-123

messagestringOptional

Additional message providing status or context.

Example: Request failed

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.

delete

/jobs/{jobId}

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

{
  "ok": false,
  "requestId": "xyz-123",
  "message": "Request  failed",
  "error": {
    "code": 404,
    "message": "Not Found",
    "description": "The requested resource was not found"
  }
}

PreviousUpdate NextOther

Last updated 10 months ago

Was this helpful?

hashtagRun a job

hashtagStop a running job

hashtagDelete a job

Run a job

Stop a running job

Delete a job