Stop a Veeam backup agent Job

In this article

    You can stop a Veeam backup agent job with the specified ID.


    To stop a running job, send the POST HTTPS request to the URL of the /backupAgents/{id}/jobs/{id}/stop resource.

    HTTP Request

    POST https://<hostname>:1281/v2/backupAgents/{id}/jobs/{id}/stop

    Request Headers

    The request header must contain the authorization token.


    The server returns the following response to the client.

    Response Code

    A successfully completed operation returns response code 200 OK.

    Response Headers

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




    The length of the response body.


    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 Stop a Veeam backup agent Job

    The following example returns a response on a stop action for a backup job with ID 4610eb17-b41c-4cc5-81d1-938ee6d89b7a.


    POST https://localhost:1281/v2/backupAgents/cc52ec30-a1b0-41dd-8b24-553dab48b43f/jobs/4610eb17-b41c-4cc5-81d1-938ee6d89b7a/stop


    Request Header:

    Content-Type: application/json

    Authorization: Bearer <Access-Token>


    Response Code:

    200 Success


    Response Body:

    "Backup job has been stopped."