This is an archive version of the document. To get the most up-to-date information, see the current version.

(POST) /backupServers/{ID}?action=collect

In this article

    Collects data from the Veeam backup server added to Veeam Backup Enterprise Manager.

    Request

    To start collecting data from the Veeam backup server, you need to send the POST HTTP request to the URL of the /backupServers/{ID}?action=collect resource.

    HTTP Request

    POST http://<Enterprise-Manager>:9399/api/backupServers/{ID}?action=collect

    Request Headers

    The request contains the following headers:

    Header

    Required

    Description

    X-RestSvcSessionId

    True

    The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. To learn more, see Authentication and Security.

    Request Body

    None.

    Query Parameters

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns response code 202 Accepted.

    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/xml.

    Response Body

    In the response body, Veeam Backup Enterprise Manager returns an ID of the task that has been created to perform the requested action, and the task state. You can check the operation results by sending the GET HTTP request to the URL of the task resource.

    Additionally, Veeam Backup Enterprise Manager returns a link to the task deletion operation. You can send the GET HTTP request to the URL in the link to stop the task execution.

    Example

    The example below starts collecting data from the Veeam backup server having ID f365fbd8-fbd2-43ad-9f7a-c87cd390a0d9.

    Request:

    POST http://localhost:9399/api/backupServers/f365fbd8-fbd2-43ad-9f7a-c87cd390a0d9?action=collect

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    202 Created

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
     <Links>
       <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
     </Links>
     <TaskId>task-1</TaskId>
     <State>Running</State>
     <Operation>CollectingBackupServer</Operation>
    </Task>

    To trace the status of the operation, send the GET HTTP request to the URL of the received task resource:

    Request:

    GET http://localhost:9399/api/tasks/task-1

     

    Request Header:

    X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj

     

    Response:

    200 Success

     

    Response Body:

    <Task xmlns="http://www.veeam.com/ent/v1.0" Type="Task" Href="http://localhost:9399/api/tasks/task-1">
    <Links>
     <Link Rel="Delete" Type="Task" Href="http://localhost:9399/api/tasks/task-1" />
    </Links>
    <TaskId>task-1</TaskId>
    <State>Finished</State>
    <Operation>CollectingBackupServer</Operation>
    <Result Success="true">
     <Message>Data collection started. To view results, go to Sessions.</Message>
    </Result>
    </Task>