This is some documentation.



add_child_entity

Adding child entity

current_entity_id Required

entity to be updated

description

the description to be set on the entity

logo_url

The URL to the logo for the entity

name

the name of the entity

url

The URL of the entities web page

user_id Required

user to be added



add_interface

entity_id Required

entity to be updated

interface_id Required

interface to be added



add_user

entity_id Required

entity to be updated

user_id Required

user to be added



get_entities

returns a JSON object representing all entities

name

Name of entity to search for.

workgroup_id Required

The workgroup id to find the ACLs for the entity



get_entity

get the details on an entity

circuit_id

The workgroup id to find the ACLs for the entity

entity_id

The Entity ID to find the interfaces for

vrf_id

The workgroup id to find the ACLs for the entity

workgroup_id

The workgroup id to find the ACLs for the entity



get_entity_children

returns the entities children

entity_id Required

The Entity ID to find the children entities



get_entity_interfaces

returns the interfaces associated to the current entity (not children)

entity_id Required

The Entity ID to find the interfaces for



get_root_entities

returns a JSON object representing the root entities



get_valid_users

returns a JSON object representing all valid user for given entity

entity_id Required

The entity id to find the users the entity



remove_interface

entity_id Required

entity to be updated

interface_id Required

interface to be removed



remove_user

entity_id Required

entity to be updated

user_id Required

user to be removed



update_entity

description

the description to be set on the entity

entity_id Required

entity to be updated

logo_url

The URL to the logo for the entity

name

the name of the entity

url

The URL of the entities web page