Before you begin working with the Abiquo API, please read Get Started with the Abiquo API, which shows you how to obtain information about your environment's resources and the API by using the Abiquo UI and API together.
To perform tasks using multiple requests using the Abiquo API, work through the API Tutorials section.
This APIExamples API Examples section contains individual reference examples that are may also be included in each method relevant methods in the API Reference section.
...
The simple cURL command examples are provided to help new developers get an overall picture of the Abiquo API. And they also informally document the vital resource navigable resource links in Abiquo data media types.
These examples are based on built from the output of the Abiquo integration tests. This means that dummy entities, strange text strings, or empty lists may at times appear in the examples.
For simplicity, user and password authentication is shown in the examples. However, for production systems, OAuth is recommended. See Authentication.
To enable cut and paste to a shell, backslashes are placed at the end of each line to escape the new line. Requests Request examples should contain single quotation marks, not back ticks, and every effort has been made to ensure that single quotation marks are used in the cURL commands in the examples, to enable copy and paste where required. However, if problems occur, try checking try checking and modifying the command in a text editor before pasting it in a shell.
You Finally, remember that you should always use the version number with your media types in requests to the Abiquo API in order to avoid compatibility issues compatibility issues in future versions. If you do not supply the version number, Abiquo will use the latest version, which may cause your integration to suffer an unexpected upgrade!
Data payloads
Put The PUT and post POST requests usually contain a request payload. We have made these payloads visible, rather than using file attachments, because we believe that they can provide useful information about the data entities involved in each query.To achieve consistency for all request payloads, regardless of their length, we use a data file format in the examples. , which is visible in its own separate section of an example. The cURL command has a "-d" parameter, which indicates the request payload. The \"@" symbol means that the following text is a file name. To run the query, you can create a file with the name requestpayload.<format>, where format could be json, xml, text, etc.
Instead of using a file, Or you could put the request payload inline. In this case, the easiest approach is to put any , moving any optional authentication line (e.g. -u user:password --verbose) above the payload line with and adding a backslash at the end. The payload line should contain -d followed by and the data entity enclosed in single quotation marks enclosing the data entity. To ensure JSON compatibility, double quotation marks should be used in JSON strings. You can validate your data entities with JSON or XML formatters or checkers.
Please remember that the example payloads are not specially designed templates for creating a new resource or modifying a resource. For create requests, you may find additional examples of simple requests in the API Reference pages, in the Abiquo API Tutorials, or you may be able to find examples of simple entities by looking at requests made by the Abiquo UI. For modify requests, you should perform a get GET of an existing object in your environment and then make your changes. See also Get Started with the Abiquo API. The Abiquo API will return a response to POST requests in the Accept media type you specify in your requests. When you use cURL, the response payload will be raw data. You can then pipe this output to a formatter or cut and paste to format it in an online tool.
...