Skip to main content
The ORIV API gives you programmatic access to the ORIV Platform. Developers, e-commerce store owners, and development agencies can use it to integrate server operations, run application tasks, and automate the workflows behind their servers. Instead of checking server stats or managing your VPS by hand, you can perform these tasks with a few simple commands, then build the dashboards, alerts, and integrations that fit how you already work.

​
Key benefits of using the ORIV API:

  • Full Platform Access: Run the same server and site operations available on the dashboard.
  • Seamless Integration: Connect ORIV to your existing tools and pipelines.
  • Automation: Run restarts, deployments, and routine tasks without manual effort.
  • Real-Time Insights: Monitor CPU, RAM, disk space, and network traffic on demand.
  • Custom Dashboards: Build your own views on top of live server data.
  • Scoped Permissions: Control access with read and write tokens for servers and sites.
  • Bulk Management: Manage multiple servers and sites in one workflow.

​
Step 1: Navigate to API Settings

First, go to your ORIV dashboard. Navigate to the left-hand sidebar menu, select Settings, and then click on the ‘Developers’ option from the left side menu and click on the ‘API Tokens’ option. Within the API tokens interface, click the Create New Token button.
[!NOTE] Precisa de ajuda visual para esta etapa? Entre em contato com o nosso suporte em support@oriv.cloud.

​
Step 2: Configure Token Name and Permissions

A pop-up will appear. Enter a descriptive name for your token and select the appropriate permissions:
  1. Full Access (all permissions)
  2. read:servers
  3. write:servers
  4. read:sites
  5. write:sites
Once configured, click Create Token.
[!NOTE] Precisa de ajuda visual para esta etapa? Entre em contato com o nosso suporte em support@oriv.cloud.

​
Step 3: Copy and Store Your API Token

After creation, your token will be displayed. Copy and store it in a secure location immediately, as you will need it for future authentication.
[!NOTE] Precisa de ajuda visual para esta etapa? Entre em contato com o nosso suporte em support@oriv.cloud.

​
Step 4: Deleting an API Token

If you no longer require a specific token, locate it in the dashboard and click the Delete icon to remove it.
[!NOTE] Precisa de ajuda visual para esta etapa? Entre em contato com o nosso suporte em support@oriv.cloud.
You now have everything you need to access the ORIV Public API. Create a token, set its permissions, and store it safely to start managing your servers programmatically.

​
📑 Explore the API Documentation

With your token ready, visit the API documentation to learn about the available endpoints and start building. If you face any issues, please do not hesitate to contact oursupport team.