Endpoints and objects specification¶

To better understand Fudo Enterprise API functionality, we can group endpoints according to object types defined in Fudo Enterprise data model.

Object type	Endpoints example
user	/user /user/<id> /user/safe/time_policy /user/safe …
server	/server /server/<id> …
account	/account /account/<id> /account/safe/listener …
safe	/safe /safe/<id> /grant/safe …
listener	/listener /listener/<id> /grant/listener …

We can also distinguish additional types of endpoint groups corresponding to the objects listed below:

pool
external_authentication
session
remote_app

…and also groups of functional methods, like:

objspec
grant
batch
network

Let’s take a closer look at the last four types in the following paragraphs.

Objspec

The objspec type, used only with the GET method, enables administrators to retrieve specifications of objects on which endpoints operate, e.g.:

/objspec/user request will return attributes of user object type,
/objspec/remote_app request will return attributes of remote_app object type.

Below you can find an example of information returned for GET https://10.0.0.0/api/v2/objspec/remote_app request.

{
    "result": "success",
    "remote_app": {
        "id": {
            "type": "string",
            "readonly": true,
            "unique": true
        },
        "name": {
            "type": "string",
            "required": true,
            "ignore_case": true,
            "unique": true
        },
        "path": {
            "type": "string",
            "required": true
        },
        "arguments": {
            "type": "string"
        },
        "created_at": {
            "type": "string",
            "readonly": true
        },
        "modified_at": {
            "type": "string",
            "readonly": true
        },
        "removed": {
            "type": "boolean",
            "readonly": true
        }
    }
}

As you can see on the above example, remote_app possess following attributes: id, name, path, arguments, created_at, modified_at and removed.

Batch

Fudo API’s batch powerfull functionality enables administrators to send batch requests, allowing them to perform nested operations with different methods. Please refere to section API v2: Batch requests.

Grant

This group, used with the GET, POST and DELETE methods, allows granting management privileges for users to selected accounts, pools, other users, listeners, safes, or servers.

Network

The Network functionality allows to retrieve network settings such as DNS address(es), Admin Panel’s address, Access Gateway’s address, global configuration parameters, network interfaces configuration or routing configuration. It is used only with the GET method. To learn more, please refer to API v2: Network section.