Manage
Run a job
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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"
}
}
Abort running job (an incomplete job that is yet to start will be deleted)
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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
The id associated with your job.
A successful response.
Returned when the users sends a malformed request.
Returned when the user is not authenticated.
Returned when the user does not have permission to access the resource.
Returned when the resource does not exist.
Returned when an error on the server occurred.
Returned when the resource is temporarily unavailable.
An unexpected error response.
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"
}
}
Last updated
Was this helpful?