GET api v3 vip request vip_request_ids

Returns a list of vip request by ids ou dict

List of vip request by ids:

Response body:

{
    "vips": [{
        "business": (string),
        "created": (boolean),
        "environmentvip": (environmentvip_id),
        "id": (vip_id),
        "ipv4": (ipv4_id),
        "ipv6": (ipv6_id),
        "name": (string),
        "options": {
            "cache_group": (optionvip_id),
            "persistence": (optionvip_id),
            "timeout": (optionvip_id),
            "traffic_return": (optionvip_id)
        },
        "ports": [{
            "id": (vip_port_id),
            "options": {
                "l4_protocol": (optionvip_id),
                "l7_protocol": (optionvip_id)
            },
            "pools": [{
                    "l7_rule": (optionvip_id),
                    "l7_value": (string),
                    "order": (interger),
                    "server_pool": (server_pool_id)
                },..],
            "port": (integer)
            },..],
        "service": (string)
    },..]
}

Param decode

{
    "extends_search": [{
        "ipv4__oct1": (ipv4__oct1),
        "ipv4__oct2": (ipv4__oct2),
        "ipv4__oct3": (ipv4__oct3),
        "ipv4__oct4": (ipv4__oct4),
        "ipv6__block1__iexact": (ipv6_block1),
        "ipv6__block2__iexact": (ipv6_block2),
        "ipv6__block3__iexact": (ipv6_block3),
        "ipv6__block4__iexact": (ipv6_block4),
        "ipv6__block5__iexact": (ipv6_block5),
        "ipv6__block6__iexact": (ipv6_block6),
        "ipv6__block7__iexact": (ipv6_block7),
        "ipv6__block8__iexact": (ipv6_block8),
        "created": (boolean),
    }],
    "start_record": (interger),
    "custom_search": "(string)",
    "end_record": (interger),
    "asorting_cols": [(string),..],
    "searchable_columns": [(string),..]
}
:return list of vips request with property "total"
{"total": (interger),
    "vips": [..]
}

Exemple with IDs:

URL:

/api/v3/vip-request/1;5/

Return vips request with id 1 and 5

{"vips": [{"id":1,...},{"id":5,... }]}

Return list of vip request by dict

URL:

/api/v3/vip-request/

GET Param:

search

Example:

/api/v3/vip-request/?search=(dict encoded)

Exemple with dict:

Search server pools where the ipv4 "192.168.x.x" and are created,or the ipv4 "x.168.17.x" and are not created.

{
    "extends_search": [{
        "ipv4__oct1": "192",
        "ipv4__oct2": "168",
        "created": true
        },
    {
        "ipv4__oct2": "168",
        "ipv4__oct3": "17",
        "created": false
    }],
    "start_record": 0,
    "custom_search": "",
    "end_record": 25,
    "asorting_cols": [],
    "searchable_columns": []
}

URL encoded:

/api/v3/vip-request/1/?search=%7B%22extends_search%22%3A%2F%2F%5B%7B%22ipv4__oct1%22%22192%22%2C%22ipv4__oct2%22%3A%22168%22%2C%22created%22%3Atrue%7D%2C%7B%22ipv4__oct2%22%3A%22168%22%2C%22ipv4__oct3%22%3A%2217%22%2C%22created%22%3Afalse%7D%5D%2C%22start_record%22%3A0%2C%22custom_search%22%3A%22%22%2C%22end_record%22%3A25%2C%22asorting_cols%22%3A%5B%5D%2C%22searchable_columns%22%3A%5B%5D%7D%7D

return list of vips request with property "total"

{
    "total": (interger),
    "vips": [..]
}