Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 5.0

Versions Compared

Key

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

...

  • To begin operations, a client must know the URI of a Server, for example, https://abiquo.example.com/api
  • The system identifies the resources using URIs, for example, https://abiquo.example.com/api/admin/enterprises, where /enterprises/ refers to the collection of enterprises and /enterprises/x refers to a single enterprise.
  • From each resource, the Abiquo API links to all of the accessible resources, and a client should reach a resource URI only be by following links from other entities. The client should avoid creating the URI of a resource
  • All requests use the Hypertext Transfer Protocol (HTTP), version 1.1 as the transport protocol. 
  • We do not recommend the use of HTTP Basic Authentication, but the Server can authenticate these requests. If you use them, they should be sent over a secure channel such as a VPN, or using the HTTPS protocol. See Authentication

...

To control the number of data entities to retrieve and/or sort entities, in order to improve the user experience, clients can specify the following pagination parameters. 

Parameter NameDescriptionDefault Value
startwithThe first element to be retrieved of the filtered search0
limitThe number of entities to retrieve. To retrieve all entities, use limit = 025
has

Filter with a text value for specific attributes. See resource documentation

''
by

Sort preference. Usually an attribute name. See resource documentation

Depends on the resource
ascSpecifies if the value of the 'by' parameter must be sorted in ascending order (true) or descending order (false)true

As described in the default value column, by default the Server filters by retrieving the first 25 entities, starting with the first one, and sorts them in ascending order. 

...

The error response data model is as follows:

Field Name

Type

Occurs

Required

Description

code

String

1

true

The internal application error code.

message

String

1

true

The description of the error

For a list of codes and messages, see API Error Code List. For a list of platform events, including actions, tracer messages, and associated error codes, see Events Table.

...