Request format¶

Please note that the query path differs depending on the API endpoints version you are using.

Note

APIv1 request format:

<method> http://<fudo_address>/api/system/<endpoint>[?<params>] <body>

APIv2 request format:

Where:

<method> - is HTTP method (GET, POST, PATCH or DELETE only allowed),

<fudo address> - is Fudo Enterprise IP address (e.g., 10.0.0.0),

<endpoint> - is chosen endpoint (e.g., /objspec/user),

<params> - is URL parameters available for a specific method (e.g., filter, offset, limit),

<body> - is request body in JSON format.

An example of the request that returns a list of available users (with no parameters specified and no body needed):

GET https://10.0.0.0/api/v2/user

An example of the request that creates user with user role and test-user name:

POST https://10.0.0.0/api/v2/user

{
  "role": "user",
  "name": "test-user"
}