OpenAPI/Swagger REST API Spec

[JalfResi]

Hi! First time user of Proxmox. Looking to automate and store my infrastructure changes as code using Terraform. Found a Proxmox Terraform plugin, but it only covers basic details, not the full suite of options available via the REST API. I was looking into adding to it when I noticed that the Proxmox REST API is very large, and was hoping to automate creation of a Go library using something like OpenAPI/Swagger, but I can't locate a spec definition anywhere. The REST API viewer is very useful but I dont want to have to port the entire API (and deal with changes) without some kind of way of automating the grunt work for client libraries.

So questions:
- Is there an OpenAPI/Swagger style spec for the REST API anywhere?
- If not, is there any plans to add one in a future release? (it looks like the API viewer is auto generated, so there maybe possible hooks there)
- Or alternatively, anyone know of a good, uptodate golang (or even better, terraform) package that covers the REST API?

Thanks everyone!

 

[thadoteu]

Unfortunately there is no official OpenAPI/Swagger Specification for Proxmox. As far as I can tell the second problem with the API viewer is, that it lacks some kind of versioning. After a recent update to a newer (minor!) Proxmox version, some endpoints are behaving strangely and no longer providing some information they provided beforehand. So most likely there were some breaking changes that were not documented properly.

 

[JalfResi]

Hmmm thats very frustrating. Makes it very difficult to write software to integrate with Proxmox if the API is in a format that makes it difficult.

 

[florian-n]

I can only urge to create a swagger api, since it's a real pain to set a virtualized proxmox-ve instance up to have an api to test against.