Skip to content


Your VyHub instance comes with a fully fetched REST API.

The API is accessible under{instance_name}/v1

Documentation and Swagger UI

You can view the documentation and interact with the api through the Swagger UI which is accessible under{instance_name}/v1/docs

Swagger UI


Some endpoints need authorization. You can set your authorization key at the top right of the documentation.

For testing purposes you can use the authorization key you get, after you logged into your instance. Open the developer options in your browser and inspect the headers of a request in the network tab.

Swagger UI

Creating API keys

New API keys with custom permissions can be created in the settings.