Start a Job

You can start Veeam Backup & Replication job with the specified ID.

Request

To start an idle job, send the POST HTTPS request to the URL of the /jobs/{ID}/start or /jobs/{ID}/action resource.

HTTP Request

POST https://<hostname>:1281/v2/jobs/{ID}/start

or

POST https://<hostname>:1281/v2/jobs/{ID}/action

Request Headers

The request header must contain the authorization token for the current logon session.

Request Body

If you decide to use the jobs/{id}/action resource you must send the start action property with the null value in the request body:

{"start": null}

Response

The server returns the following response to the client.

Response Code

A successfully completed operation returns response code 200 Success.

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the request body message: application/json; charset=utf-8

Response Body

In the response body, Veeam Service Provider Console returns a message for an action.

Example Start a Job

The following example starts a job with ID 2.

Request:

POST https://localhost:1281/v2/jobs/2/start

 

Request Header:

Content-Type: application/json

Authorization: Bearer <Access-Token>

 

Response Code:

200 Success

 

Response Body:

"Backup job has been started."

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.