This is an archive version of the document. To get the most up-to-date information, see the current version.Restarts Backup Agent
You can restart a Veeam backup agent with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To restart a Veeam backup agent, send the POST HTTP request to the URL of the /infrastructure/backupAgents/{backupAgentUid}/restart resource.
HTTP Request
POST https://<hostname>:1280/api/v3/infrastructure/backupAgents/{backupAgentUid}/restart |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
backupAgentUid | Path | String (uuid) | Yes | — | Veeam backup agent UID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns positive response code 200 OK when the collection task is added to the internal queue and not when the task is executed.
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 |
Example 
The following request restarts a Veeam backup agent with UID 304c08c2-0d13-4e9d-b26b-0bd5add83b3b.
Request: POST https://localhost:1280/api/v3/infrastructure/backupAgents/304c08c2-0d13-4e9d-b26b-0bd5add83b3b/restart
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK |