Jobs

Translation actions

Get Jobs status

get

This endpoint requires administrator permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs status success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

get/v1/jobs/status

GET /butler/api/v1/jobs/status HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs status success",
  "event": "GET",
  "items": []
}

Pause Job scheduling

put

This endpoint requires administrator permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs pause success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

put/v1/jobs/pause

PUT /butler/api/v1/jobs/pause HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs pause success",
  "event": "GET",
  "items": []
}

Resume Job scheduling

put

This endpoint requires administrator permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs resume success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

put/v1/jobs/resume

PUT /butler/api/v1/jobs/resume HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs resume success",
  "event": "GET",
  "items": []
}

Get active Jobs

get

This endpoint requires Jobs permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs list success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

get/v1/jobs

GET /butler/api/v1/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs list success",
  "event": "GET",
  "items": []
}

Create a new Job

post

This endpoint requires Jobs permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

displayNamestringRequired

A job name

Example: fancy-job

imageIdstringRequired

The Virtual Environment image id

Example: firefox

routerIdstringRequired

The egress Router id

Example: lax81uq4

resolutionstringRequired

The Virtual Environment resolution

Example: 1280x1024

expiresnumber · min: 10 · max: 60Required

The max run time of the job in minutes

Example: 10

retriesnumberRequired

The number of times to retry failed jobs

Example: 0

patternstringRequired

A cron schedule pattern

Example: 0 * * * *

storageIdstringRequired

The Enclave Storage id

Example: a7836ff8-53fa-4c5f-9869-4947a4c16a83

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs create success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

post/v1/jobs

POST /butler/api/v1/jobs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "displayName": "fancy-job",
  "imageId": "firefox",
  "routerId": "lax81uq4",
  "resolution": "1280x1024",
  "expires": "10",
  "retries": "0",
  "pattern": "0 * * * *",
  "assignee": {
    "id": "The assignee id",
    "type": "user"
  },
  "storageId": "a7836ff8-53fa-4c5f-9869-4947a4c16a83"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs create success",
  "event": "GET",
  "items": []
}

Update existing Job

put

This endpoint requires Jobs permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdstringRequired

The Job Id

Body

displayNamestringRequired

A job name

Example: fancy-job

imageIdstringRequired

The Virtual Environment image id

Example: firefox

routerIdstringRequired

The egress Router id

Example: lax81uq4

resolutionstringRequired

The Virtual Environment resolution

Example: 1280x1024

expiresnumber · min: 10 · max: 60Required

The max run time of the job in minutes

Example: 10

retriesnumberRequired

The number of times to retry failed jobs

Example: 0

patternstringRequired

A cron schedule pattern

Example: 0 * * * *

storageIdstringRequired

The Enclave Storage id

Example: a7836ff8-53fa-4c5f-9869-4947a4c16a83

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs update success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

put/v1/jobs/{jobId}

PUT /butler/api/v1/jobs/{jobId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 246

{
  "displayName": "fancy-job",
  "imageId": "firefox",
  "routerId": "lax81uq4",
  "resolution": "1280x1024",
  "expires": "10",
  "retries": "0",
  "pattern": "0 * * * *",
  "assignee": {
    "id": "The assignee id",
    "type": "user"
  },
  "storageId": "a7836ff8-53fa-4c5f-9869-4947a4c16a83"
}

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs update success",
  "event": "GET",
  "items": []
}

Delete a Job

delete

This endpoint requires Jobs permissions

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

jobIdstringRequired

The Job Id

Responses

200Success

application/json

statusCodeintegerOptionalExample: 200

successbooleanOptionalExample: true

messageanyOptionalExample: Jobs delete success

eventstring · enumOptionalPossible values:

itemsarrayOptional

500Error

application/json

delete/v1/jobs/{jobId}

DELETE /butler/api/v1/jobs/{jobId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "statusCode": "200",
  "success": "true",
  "message": "Jobs delete success",
  "event": "GET",
  "items": []
}

PreviousEvents

Last updated 2 months ago

Was this helpful?