Policies

List Policies

This path returns the list of policies.

Method	Path
GET	/api/v1/policies

Query Parameters

Name	In	Type	Default	Allowed	Description
page	query	int	1	>= 1	1-based page index.
per_page	query	int	25	1…100	Number of items per page.

Sample Response

{
    "result": {
        "items": [
            {
                "name": "default",
                "bitrate_uplink": "200 Mbps",
                "bitrate_downlink": "100 Mbps",
                "var5qi": 9,
                "arp": 1,
                "data_network_name": "internet"
            }
        ],
        "page": 1,
        "per_page": 10,
        "total_count": 1
    }
}

Create a Policy

This path creates a new policy.

Method	Path
POST	/api/v1/policies

Parameters

• name (string): The Name of the policy.
• bitrate_uplink (string): The uplink bitrate of the policy. Must be in the format <number> <unit>. Allowed units are Mbps, Gbps.
• bitrate_downlink (string): The downlink bitrate of the policy. Must be in the format <number> <unit>. Allowed units are Mbps, Gbps.
• var5qi (integer): The QoS class identifier of the policy. Must be an integer between 1 and 255.
• arp (integer): The Allocation and Retention Priority (ARP) of the policy. Must be an integer between 1 and 15.
• data_network_name (string): The name of the data network associated with the policy. Must be the name of an existing data network.

Sample Response

{
    "result": {
        "message": "Policy created successfully"
    }
}

Update a Policy

This path updates an existing policy.

Method	Path
PUT	/api/v1/policies/{name}

Parameters

• bitrate_uplink (string): The uplink bitrate of the policy. Must be in the format <number> <unit>. Allowed units are Mbps, Gbps.
• bitrate_downlink (string): The downlink bitrate of the policy. Must be in the format <number> <unit>. Allowed units are Mbps, Gbps.
• var5qi (integer): The QoS class identifier of the policy. Must be an integer between 1 and 255.
• arp (integer): The Allocation and Retention Priority (ARP) of the policy. Must be an integer between 1 and 15.
• data_network_name (string): The name of the data network associated with the policy. Must be the name of an existing data network.

Sample Response

{
    "result": {
        "message": "Policy updated successfully"
    }
}

Get a Policy

This path returns the details of a specific policy.

Method	Path
GET	/api/v1/policies/{name}

Parameters

None

Sample Response

{
    "result": {
        "name": "my-policy",
        "bitrate_uplink": "10 Mbps",
        "bitrate_downlink": "10 Mbps",
        "var5qi": 9,
        "arp": 1,
        "data_network_name": "internet"
    }
}

Delete a Policy

This path deletes a policy from Ella Core.

Method	Path
DELETE	/api/v1/policies/{name}

Parameters

None

Sample Response

{
    "result": {
        "message": "Policy deleted successfully"
    }
}