Veeam Backup & Replication 10
Veeam RESTful API Reference
Related documents

(GET) /externalRepositories/{ID}

Returns a resource representation of an external backup repository having the specified ID. The external backup repository is added to the Veeam backup server connected to Veeam Backup Enterprise Manager.


To get a backup repository, you need to send the GET HTTP request to the URL of the /externalRepositories/{ID} resource.

HTTP Request

GET https://<Enterprise-Manager>:9398/api/externalRepositories/{ID}

Request Headers

The request contains the following headers:






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.



Identifies the format of the response. Possible values:

  • application/xml — the client can send this value in the header to accept response in the XML format.
  • application/json — the client must send this value in the header to accept the request in the JSON format.

If the request does not contain the header, the server will return the response in the XML format.

Request Body



The server returns the following response to the client.

Response Codes

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. Possible values:

  • application/xml
  • application/json

Response Body

In the response body, Veeam Backup Enterprise Manager returns a representation of the /repositories/{ID} resource.


The example below returns a backup repository having ID 06ff6c99-f457-4fd3-87da-4d00291d3eae.


GET https://localhost:9398/api/externalRepositories/06ff6c99-f457-4fd3-87da-4d00291d3eae?format=Entity


Request Header:

X-RestSvcSessionId   NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj



200 OK


Response Body:

<ExternalRepository Href="" Type="ExternalRepository" Name="External repository" UID="urn:veeam:ExternalRepository:06ff6c99-f457-4fd3-87da-4d00291d3eae" xmlns="" xmlns:xsd="" xmlns:xsi="">
   <Link Href="" Name="" Type="BackupServerReference" Rel="Up"/>
   <Link Href="" Name="External repository" Type="ExternalRepositoryReference" Rel="Alternate"/>
   <Link Href="" Type="BackupReferenceList" Rel="Down"/>
 <Description>Created by srv02\admin at 12/11/2018 22:05.</Description>

This Document Help Center
User Guide for VMware vSphereUser Guide for Microsoft Hyper-VVeeam Backup Enterprise Manager GuideVeeam Agent Management GuideVeeam Cloud Connect GuideVeeam Explorers User GuideVeeam Plug-ins for Enterprise Applications GuideIntegration with Veeam Backup for AWS User GuideVeeam PowerShell ReferenceVeeam Explorers PowerShell ReferenceVeeam RESTful API ReferenceRequired Permissions for VMware vSphereQuick Start Guide for VMware vSphereQuick Start Guide for Microsoft Hyper-VVeeam ONE DocumentationVeeam Agent for Windows DocumentationVeeam Agent for Linux DocumentationVeeam Backup for AWS DocumentationVeeam Backup for Microsoft Azure DocumentationVeeam Backup for Nutanix AHV User GuideVeeam Backup for Microsoft Office 365 DocumentationVeeam Management Pack Documentation
I want to report a typo

There is a misspelling right here:


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