OneProvider Public API Overview

OneProvider provides a public API that allow its clients to manage their account without having to login the OnePanel and navigate it. A variety of actions is left to the disposition of the clients allowing them to manage their servers, tickets and account as well as even generate new order and paid invoices.

API Utilization

Product Management

Use your API access as a service manager. Manage your products, buy new servers and view your support tickets.

Create your own panel

Create your own management panel for your clients. Ideal for resellers and use OneProvider API to display and sell configurations.

Make everything simple

Automate many tasks through scripting. Bind and develop your own functions. Increase productivity with crons scripts. Notifications and tasks optimizated to your needs.

Full API Documentation

API Methods

/SERVER

GET
/server/list
Get a list of all services.
GET
/server/info/server_id
Get a server's information.
GET
/server/manage/server_id
Get a list of the available methods for a server.
POST
/server/action
Manage a server.
POST
/server/cancel
Request a cancellation for a service.
POST
/server/remove/cancellation
Remove a cancellation request on a service.
POST
/server/hostname
Change a server's hostname.

/VM

GET
/vm/project/list
Get your projects.
GET
/vm/listing/project_uuid
Get a list of your virtual servers.
GET
/vm/info/vm_id
Get a VM's information.
GET
/vm/templates
Get a list of the available OS.
GET
/vm/locations
Get a list of the available locations.
GET
/vm/sizes
Get a VM's size.
GET
/vm/sshkeys/list
Get your SSH keys.
GET
/vm/images/list
Get your instances' images.
POST
/vm/addon/add
Add an addon to a VM.
POST
/vm/addon/remove
Remove an addon from a VM.
POST
/vm/bandwidth/suspend
Toggle automatic bandwidth suspension.
POST
/vm/boot
Boot a virtual server.
POST
/vm/bootorder
Change the VM boot sequence.
POST
/vm/create
Create a VM.
POST
/vm/resize
Resize a VM.
POST
/vm/destroy
Destroy VM.
POST
/vm/hostname
Change VM hostname.
POST
/vm/image/create
Create image.
POST
/vm/image/delete
Delete image.
POST
/vm/image/rename
Rename image.
POST
/vm/mountiso
Mount an ISO image.
POST
/vm/unmountiso
Unmount an ISO image.
POST
/vm/pae
Turn PAE on/off.
POST
/vm/password
Change root password.
POST
/vm/poweroff
Power off instance.
POST
/vm/project/new
Create a new OC project.
POST
/vm/project/assign
Assign an instance to a project.
POST
/vm/project/delete
Delete project.
POST
/vm/project/edit
Edit project.
POST
/vm/reboot
Reboot a virtual server.
POST
/vm/reinstall
Reinstall a VM.
POST
/vm/restore
Restore image.
POST
/vm/shutdown
Shutdown a virtual server.
POST
/vm/sshkey/delete
Delete SSH key.
POST
/vm/sshkey/edit
Rename SSH key.
POST
/vm/sshkey/new
New SSH Key.
POST
/vm/vnc
Get VNC credentials.
POST
/vm/vnc/password
Change VNC Password.

/STORE

GET
/store/configs
Get a list of configs found in our catalogue.
GET
/store/configs/config_id
Get information on a specified config.
GET
/store/configs/config_id/drives
Get a list of available drives for the config.
GET
/store/configs/config_id/softwares
Get a list of available softwares for the config.
GET
/store/configs/config_id/upgrades
Get a list of available upgrades for the config.
GET
/store/configs/cycles
Get a list of billing cycles available when ordering configs.
GET
/store/configs/locations
Get a list of locations where our configs can be found.
GET
/store/configs/upgrades
Get a list of upgrades that can be available in some of our configs.
GET
/store/carts
Get the client's list of carts.
GET
/store/carts/cart_id
Get information on a specified cart.
POST
/store/carts
Create a new shopping cart or return the current active one.
POST
/store/carts/cart_id/clear
Empty and reset the settings of a shopping cart.
POST
/store/carts/cart_id/items/config_id/add
Add or update an item in the cart.
POST
/store/carts/cart_id/items/config_id/remove
Remove an item from the cart.
POST
/store/carts/cart_id/update
Update the specified cart.
POST
/store/orders
Create a new order from the given cart.
POST
/store/orders/order_id/cancel
Send an order cancellation request.
GET
/store/orders
Get the client's list of orders.
GET
/store/orders/order_id
Get information on a specified order.

/INVOICES

GET
/invoices
Get a list of your invoices.
GET
/invoices/invoice_id
Get a single invoice's content.
POST
/invoices/invoice_id/pay
Pay an invoice.
POST
/invoices/invoice_id/split (Only available to reseller)
Split an invoice into multiple invoices.

/ACCOUNT

GET
/account
Get your account's information.

/SUPPORT (VIP Support subscribers only)

GET
/support/tickets
Get a list of all your open/unread support tickets.
GET
/support/tickets/ticket_id
Get a single support ticket's content and mark it as read.
GET
/support/tickets/departments
Get a list of all support departments and sub-departments.
POST
/support/tickets/
Open a new support ticket.
POST
/support/tickets/ticket_id/reopen
Reopen a closed support ticket.
POST
/support/tickets/ticket_id/close
Close an open support ticket.
POST
/support/tickets/ticket_id/reply
Add a reply to a support ticket.