RESTful knowledge exchange
Post Reply
excpt
Novice
Posts: 3
Liked: never
Joined: Jan 02, 2015 11:15 pm
Full Name: Tim Rudat
Location: Nuremberg, Germany
Contact:

Update Veeam Backup & Replication REST API Docs

Post by excpt »

The current provided documentation of the REST API is not up to date.

I'm fully authenticated with the server and I have a working session.

e.g.

requesting via get

Code: Select all

https://my.enterprise.manager.server:9398/tenants
results in a 404 response.
documentation: http://helpcenter.veeam.com/backup/80/r ... nants.html

The correct path seems to be

Code: Select all

https://my.enterprise.manager.server:9398/cloud/tenants
. But I'm not 100% shure about that, because I get a 403 response from the server that I have not the credentials for accessing this section. But I am authenticated as the administrator and a Cloud Provider License is installed on the server.

I'm currently implementing a Ruby API interface to plug a AngularJs interface on top of it for our customers to be able to order some online backup space for their backups.

When will the new docs be available?
excpt
Novice
Posts: 3
Liked: never
Joined: Jan 02, 2015 11:15 pm
Full Name: Tim Rudat
Location: Nuremberg, Germany
Contact:

Re: Update Veeam Backup & Replication REST API Docs

Post by excpt »

My lessons learned with 1.1 api and Cloud Connect features.

First make sure the use of API version 1.1. With version 1.0 you won't have access to this part of the api.

Authenticated against one of the URLs (add the authentications parameters to the post request, @docs: http://helpcenter.veeam.com/backup/80/r ... nmngr.html):

Code: Select all

POST: https://<veeam.enterprise.manager.server>:9398/api/sessionMngr/?v=v1_1

POST: http://<veeam.enterprise.manager.server>:9399/api/sessionMngr/?v=v1_1
The correct API endpoint for tenants and gateways is:

Code: Select all

GET: https://<veeam.enterprise.manager.server>:9398/api/cloud/gateways

GET: https://<veeam.enterprise.manager.server>:9398/api/cloud/tenants
I hope it helps some people who are running into the same issues.
dellock6
Veeam Software
Posts: 6137
Liked: 1928 times
Joined: Jul 26, 2009 3:39 pm
Full Name: Luca Dell'Oca
Location: Varese, Italy
Contact:

Re: Update Veeam Backup & Replication REST API Docs

Post by dellock6 »

Hi Tim,
I'm not an expert on RestFUL APIs, but if you look here (http://helpcenter.veeam.com/backup/80/r ... kflow.html) it's clearly stated the endpoint is always /api/ something, plus the different folders for the different objects.
More in general, two notes for you:
- if you have questions related to Cloud Connect as a provider, you better register to the dedicated VCP forum and post new threads there
- you can always use the online version of the user guides (like the one I linked before or http://helpcenter.veeam.com/backup/80/cloud/ for Cloud Connect) and, at the end of any page, there is a "Send Feedback" button. This goes straight to our tech writing team, and moving forward, the html version of the guide will be always more accurate than the pdf versions since it can be updated in real time, while pdf are recreated once in a while.

Thanks,
Luca.
Luca Dell'Oca
Principal EMEA Cloud Architect @ Veeam Software

@dellock6
https://www.virtualtothecore.com/
vExpert 2011 -> 2022
Veeam VMCE #1
excpt
Novice
Posts: 3
Liked: never
Joined: Jan 02, 2015 11:15 pm
Full Name: Tim Rudat
Location: Nuremberg, Germany
Contact:

Re: Update Veeam Backup & Replication REST API Docs

Post by excpt »

Hi Luca,

thanks for the reply.

I'll use the feedback option to inform the documentation about the issues.
veremin
Product Manager
Posts: 20270
Liked: 2252 times
Joined: Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin
Contact:

Re: Update Veeam Backup & Replication REST API Docs

Post by veremin »

Thank you, Tim, for raising this issue. I've already passed this information to our technical writers.
veremin
Product Manager
Posts: 20270
Liked: 2252 times
Joined: Oct 26, 2012 3:28 pm
Full Name: Vladimir Eremin
Contact:

Re: Update Veeam Backup & Replication REST API Docs

Post by veremin »

The documentation has been updated. If you can't see changes done, refresh a page, using Ctrl+F5. Thanks.
Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests