Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • The OnApp API is RESTful
  • All function calls respond to XML and JSON exchange formats
  • All function calls need authorization and authentication (Basic HTTP or API key)
  • The OnApp API is backward compatible within one major version. However, a new major version might include changes that are not  backward compatible with the previous one.

API Authentication

To authenticate using HTTP Basic, just use your username/password combination. Curl example:

...

To authenticate using API key, put your account email as a login and the key to the server as a password.

HTTP Methods

The API uses the following HTTP methods:

...

DELETE - used for object deletion

HTTP response codes

The API returns appropriate HTTP status codes for every request:

200 OK

The request completed successfully

204 No content

The request completed successfully. The 204 status is returned on DELETE and PUT requests

201 Scheduled

The request has been accepted and scheduled for processing

403 Forbidden

The request is correct, but could not be processed.

404 Not Found

The requested URL is incorrect or the resource does not exist. For example, if you request to delete a user with ID {5}, but there is no such a user in the cloud, you will get a 404 error. 

422 Unprocessable Entity

The sent parameters are erroneous.

500 Internal Server Error

  An error occurred. Please contact support.

503 Service UnavailableThe request cannot be handled currently, due to a temporary overloading or maintenance of the server. This condition is temporary and the request will be handed after a certain delay.


Formatting and naming conventions

The table below represents all the existing formatting and naming conventions used in this guide:

Convention

Explanation

Example

user:userpass

stands for username:password combination

Admin:123456

onapp.test

stands for address, where your Control Panel is located

Example.com

:id

stands for the resource ID.
Sometimes also: :resource_id

23

italics

all the parameters are italicised

currency_code

* (asterisk)

marks the required parameters

label *

preformatted

indicates request examples in XML or JSON

GET /roles.xml
Code Block
 

Code block indicates console requests and response examples.


Code Block
 
Info

info

An info message emphasizes or explains the information within the chapter.
Info

Clicking the OFF button performs graceful shutdown and then powers off the VS.


Note

note

A note message contains information essential for the task completion.
Note

The maximum length of a Mount Point is 256 characters.

Warning

warning

A warning message informs you of something you should not do or be cautious.
Warning

You won't be able to restore a VS after deleting it.

(lightbulb)The element showing new parameters added in the latest release of API.(lightbulb) limit_type – hourly or monthly limit type set for the resource

FAQ

Q: Is it possible to enable API access via https?

...