Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
auth
6
Metadata
1
users
4
get
/auth/users
Fetch all users
post
/auth/users
Create a new user
put
/auth/users/{id}
Update user
delete
/auth/users/{id}
Delete user
post
/config/loadbalancer
Create a new Load balancer service
get
/config/loadbalancer/all
Get all of the load balancer services
delete
/config/loadbalancer/all
Delete all Load balancer services
delete
/config/loadbalancer/name/{lb_name}
Delete an existing Load balancer service
delete
/config/loadbalancer/externalipaddress/{ip_address}/port/{port}/protocol/{proto}
Delete an existing Load balancer service
delete
/config/loadbalancer/externalipaddress/{ip_address}/port/{port}/portmax/{portmax}/protocol/{proto}
Delete an existing Load balancer service
delete
/config/loadbalancer/hosturl/{hosturl}/externalipaddress/{ip_address}/port/{port}/portmax/{portmax}/protocol/{proto}
Delete an existing Load balancer service
delete
/config/loadbalancer/hosturl/{hosturl}/externalipaddress/{ip_address}/port/{port}/protocol/{proto}
Delete an existing Load balancer service
get
/config/conntrack/all
Get all of the conntrack entries.
get
/config/port/all
Get all of the port interfaces
get
/config/route/all
Get all route table
post
/config/route
Create a new route config
delete
/config/route/destinationIPNet/{ip_address}/{mask}
Create a new Load balancer service
get
/config/session/all
Get all of the port interfaces
post
/config/session
Create a new session config
delete
/config/session/ident/{ident}
Create a new Load balancer service
get
/config/sessionulcl/all
Get
post
/config/sessionulcl
Create a new session config
delete
/config/sessionulcl/ident/{ident}/ulclAddress/{ip_address}
Create a new Load balancer service
get
/config/policy/all
Get
post
/config/policy
Create a new Policy QoS config
delete
/config/policy/ident/{ident}
Delete a Policy QoS service
get
/config/mirror/all
Get
post
/config/mirror
Create a new Mirror config
delete
/config/mirror/ident/{ident}
Delete a Mirror service
get
/config/ipv4address/all
Get IPv4 addresses in the device(interface)
post
/config/ipv4address
Assign IPv4 addresses in the device
delete
/config/ipv4address/{ip_address}/{mask}/dev/{if_name}
Delete IPv4 addresses in the device
get
/config/neighbor/all
Get IPv4 neighbor in the device(interface)
post
/config/neighbor
Assign IPv4 neighbor in the device
delete
/config/neighbor/{ip_address}/dev/{if_name}
Delete IPv4 neighbor in the device
get
/config/fdb/all
Get FDB in the device(interface)
post
/config/fdb
Assign FDB in the device
delete
/config/fdb/{mac_address}/dev/{if_name}
Delete FDB in the device
get
/config/vlan/all
Get vlan in the device
post
/config/vlan
Create vlan interface in the device
delete
/config/vlan/{vlan_id}
Delete vlan in the device
post
/config/vlan/{vlan_id}/member
Add a physical port to a vlan interface
delete
/config/vlan/{vlan_id}/member/{if_name}/tagged/{tagged}
Remove a vlan member from a vlan interface
get
/config/tunnel/vxlan/all
Get a list of vxlan configurations
post
/config/tunnel/vxlan
Add a one of vxlan configuration
delete
/config/tunnel/vxlan/{vxlanID}
Delete a one of vxlan configuration
post
/config/tunnel/vxlan/{vxlanID}/peer
Add a one of vxlan remote(peer) ip address configuration
delete
/config/tunnel/vxlan/{vxlanID}/peer/{PeerIP}
Remove a one of vxlan remote(peer) ip address configuration
get
/config/cistate/all
Get Cluster Instance State in the device
post
/config/cistate
Informs Current Cluster Instance state in the device
get
/config/endpoint/all
Get End-Points State in loxilb
post
/config/endpoint
Adds a LB endpoint for monitoring
post
/config/endpointhoststate
Sets the state of a host
delete
/config/endpoint/epipaddress/{ip_address}
Delete an LB end-point from monitoring
get
/config/firewall/all
Get all of the firewall config
post
/config/firewall
Create a new firewall config
delete
/config/firewall
Delete of the firewall service
get
/status/process
Get a process based on CPU usage info in the device
get
/status/device
Get a basic info in the device
get
/status/filesystem
Get a File System info in the device
get
/config/params
Get Operational params of LoxiLB
post
/config/params
Set Operational parameters of LoxiLB
get
/config/bgp/neigh/all
Get the all of BGP Neighbor
post
/config/bgp/neigh
Adds a BGP Neighbor
delete
/config/bgp/neigh/{ip_address}
Delete a BGP neighbor
get
/config/bgp/policy/definedsets/{defineset_type}/{type_name}
Get the all of BGP definedsets
delete
/config/bgp/policy/definedsets/{defineset_type}/{type_name}
Delete a BGP definedsets
post
/config/bgp/policy/definedsets/{defineset_type}
Adds a BGP definedsets for making Policy
get
/config/bgp/policy/definitions/all
Get BGP Policy definitions
post
/config/bgp/policy/definitions
Adds a BGP Policy
delete
/config/bgp/policy/definitions/{policy_name}
Delete a BGP policy
post
/config/bgp/policy/apply
Apply BGP Policy in neighbor
delete
/config/bgp/policy/apply
Delete BGP Policy in neighbor
post
/config/bgp/global
Adds a BGP global config
get
/metrics
Scrape metrics from the cache
get
/config/metrics
Get prometheus config value
post
/config/metrics
turn on prometheus option
delete
/config/metrics
turn off prometheus option
get
/version
Get version information in the device
get
/config/bfd/all
Get BFD session inforrmation in the device
post
/config/bfd
Create vlan interface in the device
delete
/config/bfd/remoteIP/{remote_ip}
Delete a BFD session
get
/metrics/flowcount
Get flow count metrics
get
/metrics/hostcount
Get host count metrics
get
/metrics/lbrulecount
Get load balancer rule count metrics
get
/metrics/newflowcount
Get new flow count metrics
get
/metrics/requestcount
Get request count metrics
get
/metrics/errorcount
Get error count metrics
get
/metrics/processedtraffic
Get processed traffic metrics
get
/metrics/lbprocessedtraffic
Get load balancer processed traffic metrics
get
/metrics/epdisttraffic
Get endpoint distribution traffic metrics
get
/metrics/servicedisttraffic
Get service distribution traffic metrics
get
/metrics/fwdrops
Get firewall drops metrics
get
/metrics/reqcountperclient
Get request count per client metrics
get
/logs
Fetch logs with optional filtering
get
/log-archives
List available log archives
get
/log-archives/{filename}
Download a specific log archive
get
/nodegraph/all
List current topology
get
/nodegraph/{service}
List current topology for a specific service
get
/config/cors/all
Get all related K8s metadata (Pod, Service, Endpoint, Node, Namespace)
post
/config/cors
Post full K8s metadata set (Pod, Service, Endpoint, Node, Namespace)
delete
/config/cors/{cors_url}
Delete a BFD session
post
/config/import
Import configurations
get
/config/export
Export all configurations
users
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Fetch all users
get
/auth/users
Jan 23, 2025
62cad44fb917
Revision changes
info
endpoint added
Jun 29, 2023
0e6bd4e2dcc9
Revision changes
breaking
api path removed without deprecation