/v2/projects/{project_id}/links/{link_id}/available_filters¶
Contents
GET /v2/projects/{project_id}/links/{link_id}/available_filters¶
Return the list of filters available for this link
Parameters¶
- project_id: Project UUID
- link_id: Link UUID
Response status codes¶
- 200: List of filters
- 400: Invalid request
Sample session¶
curl -i -X GET 'http://localhost:3080/v2/projects/101dc781-9625-4f4d-8dfc-68b50b9f5936/links/f7746aee-b800-4e61-937f-ef07a81384c4/available_filters'
GET /v2/projects/101dc781-9625-4f4d-8dfc-68b50b9f5936/links/f7746aee-b800-4e61-937f-ef07a81384c4/available_filters HTTP/1.1
HTTP/1.1 200
Connection: close
Content-Length: 2119
Content-Type: application/json
Date: Thu, 14 Jun 2018 08:35:14 GMT
Server: Python/3.5 GNS3/2.1.8dev1
X-Route: /v2/projects/{project_id}/links/{link_id}/available_filters
[
{
"description": "It will drop everything with a -1 frequency, drop every Nth packet with a positive frequency, or drop nothing",
"name": "Frequency drop",
"parameters": [
{
"maximum": 32767,
"minimum": -1,
"name": "Frequency",
"type": "int",
"unit": "th packet"
}
],
"type": "frequency_drop"
},
{
"description": "The percentage represents the chance for a packet to be lost",
"name": "Packet loss",
"parameters": [
{
"maximum": 100,
"minimum": 0,
"name": "Chance",
"type": "int",
"unit": "%"
}
],
"type": "packet_loss"
},
{
"description": "Delay packets in milliseconds. You can add jitter in milliseconds (+/-) of the delay",
"name": "Delay",
"parameters": [
{
"maximum": 32767,
"minimum": 0,
"name": "Latency",
"type": "int",
"unit": "ms"
},
{
"maximum": 32767,
"minimum": 0,
"name": "Jitter (-/+)",
"type": "int",
"unit": "ms"
}
],
"type": "delay"
},
{
"description": "The percentage represents the chance for a packet to be corrupted",
"name": "Corrupt",
"parameters": [
{
"maximum": 100,
"minimum": 0,
"name": "Chance",
"type": "int",
"unit": "%"
}
],
"type": "corrupt"
},
{
"description": "This filter will drop any packet matching a BPF expression. Put one expression per line",
"name": "Berkeley Packet Filter (BPF)",
"parameters": [
{
"name": "Filters",
"type": "text"
}
],
"type": "bpf"
}
]