Get all Realms

Retrieve a list of all Realms in the application. These are sometimes called "Application Sections".

Request

Endpoint: /api/realms
Method: GET
Headers: Accept: application/vnd.cloudlx.v1+json
Authorization: Bearer <access_token>

Response

Example:

                                
    {
        "realms": [
            {
                "id": 1,
                "name": "Default",
                "description": "The default realm"
            },
            {
                "id": 2,
                "name": "Networking",
                "description": "Cloud Link Exchange"
            },
            ...
        ]
    }
                                
                            
id Description The id of the realm
Type Integer
Example 1
name Description The name of the realm
Type String
Example 44
description Description A human readable description of the realm
Type String
Example Cloud Link Exchange

Back to top