Nebula API

Dpj

It isn't possible to create organizations, and sites etc. i think? (at least i haven't seen an option for it) It would be great if that would be possible. Do you have any idea if there will be an api upgrade in the (near) future, and what will change?

Zyxel_Melen

Hi @Dpj,

After checking, we will implement the "create organization/site" to Nebula openAPI at the end of Q3. You may also check Nebula openAPI document website for the news. In addition, if this API releases earlier, I will update this post.

Zyxel_Judy

Hi @Dpj ,

The Nebula API currently supports data retrieval for organizations and sites, but not programmatic creation of these entities. We'll evaluate your request for this feature.

Could you share your business scale - such as device count and the number of Nebula orgs/sites you need to create, etc.?

Dpj

We are working on a new business. At the moment in the old business we have 500+ devices. But it would be nice, because nebula is not the only thing we use, but also other portals. How nice would it be if we could create a scripts, which creates all the organizations in 1 click. Instead of logging into nebula and manualy create them. (of course we are working with templates, but still, scripting would be a lot faster, and also more error proof.

Zyxel_Melen

Hi @Dpj,

After checking, we will implement the "create organization/site" to Nebula openAPI at the end of Q3. You may also check Nebula openAPI document website for the news. In addition, if this API releases earlier, I will update this post.

Dpj

That's great news! Thx.

dpipro

Hello,

any improvements on the OpenAPI for the new Nebula 20.20?

Thank you

Zyxel_Melen

Hi @dpipro

Please check the supported API in this URL:

https://zyxelnetworks.github.io/NebulaOpenAPI/doc/openapi.html

dpipro

Regarding the Nebula OpenAPI, we are having some trouble with the endpoint vpn-status.

For one of our sites, the API simply returns:

{
  "status": 422,
  "message": "'hostname'"
}

The OpenAPI specification documents HTTP 422 validation errors using a detail array containing structured validation information.

This creates some inconsistencies:

• The actual HTTP status is 500, while the response body reports 422.
• The response does not follow the documented validation error schema.
• The response message is generic and doesn't clarify what's the problem.

The same requests succeed for another site using the same API key.

Could you confirm whether this is an unhandled backend exception or an issue with the affected site's data?