{"type":"model","meta":{"id":"/apps/pubhub/media/000-v7-apis/5b3454a4300b838cc17f7b2cdc0690fdd15058d5/f257d527-45cb-3d96-affe-7a58f0de8a6c","info":{"description":"Manage labels applied to endpoint agents using this API.\n","title":"Endpoint Agent Labels API","version":"7.0.34"},"security":[{"BearerAuth":[]}],"tags":[{"name":"Endpoint Agent Labels"}],"openapi":"3.0.1","servers":[{"description":"ThousandEyes API production URL","url":"https://api.thousandeyes.com/v7"}],"securitySchemes":{"BearerAuth":{"description":"Bearer authentication token","scheme":"bearer","type":"http"}}},"spec":{"description":"A label definition.","properties":{"id":{"description":"Label identifier.","example":"abc-123-def","readOnly":true,"type":"string"},"name":{"description":"The label name.","example":"Head office meeting rooms","readOnly":false,"type":"string"},"color":{"description":"UI color","example":"#ff3333","readOnly":false,"type":"string"},"matchType":{"description":"Specifies how the filters are combined for matching this label.\n\n* `and`: All filters must be matched.\n* `or`: Any of the filters should match.\n","enum":["and","or"],"example":"and","readOnly":false,"type":"string","$$ref":"#/components/schemas/MatchType"},"filters":{"description":"The filters combined using the matchType to determine the label's match.","items":{"properties":{"key":{"description":"Type of filter - the data that will be used to filter.","enum":["agent-id","public-network","local-network","connection","gateway","platform","agent-type","vpn-vendor","vpn-gateway-address","vpn-client-network","vpn-client-address","ip-address-family","ssid","bssid","hostname","username","asn"],"example":"vpn-client-network","type":"string","$$ref":"#/components/schemas/FilterType"},"values":{"example":["10.1.1.0/24","192.168.1.0/24"],"items":{"description":"Value depends on the key, and may change in the future.\n\n* `agent-id`: The agent identifiers.\n* `gateway`: The gateway IP to match.\n* `ssid`: A wildcard match on the SSID. Supports `*` for any characters and `?` for any single character.\n* `user-name`: A wildcard match on the users that use the agent. Supports `*` for any characters and `?` for any single character.\n* `hostname`: A wildcard match on the host name - supports `*` for any characters\nand `?` for any single character\n* `bssid`: BSSID for the wifi, lower case, with colons.\n* `platform`: Currently supports `Mac`, `Windows`, and `Linux`.\n* `asn`: Integer AS Number.\n* `public-network`: Network for agent's public IP in CIDR format, or IP for single IP. e.g. `192.45.32.0/22`.\n* `local-network`: Network for agent's local IP in CIDR format, or IP for single IP. e.g. `10.100.64.0/20`.\n* `connection`: Type of connection `Ethernet` or `Wireless`.\n* `agent-type`: Type of agent `endpoint`, `endpoint-pulse` or `endpoint-csc`.\n* `ip-address-family`: `ipv4` or `ipv6`.\n* `vpn-vendor`: Vendor of the VPN software. \n Examples include: \n \n * `cisco-anyconnect`\n * `palo-alto-globalprotect`\n * `ivanti-connect-secure`\n * `zscaler-internet-access`\n * `f5-big-ip`\n* `vpn-gateway-address`: Server-side VPN connection IP address.\n* `vpn-client-network`: Network for the VPN client IP in CIDR format. For example, `10.100.32.128/25`.\n* `vpn-client-address`: The VPN client IP. For example, `10.100.32.165`.\n","example":"10.1.1.0/24","type":"string"},"type":"array"},"mode":{"description":"Type of matching to be applied for the values:\n\n* `in`: The value on the agent must match one of the list of values provided.\n* `not-in`: The value on the agent must not match any of the list of values provided.\n","enum":["in","not-in"],"type":"string","$$ref":"#/components/schemas/LabelFilterMode"}},"type":"object","$$ref":"#/components/schemas/Filter"},"readOnly":false,"type":"array"}},"type":"object","$$ref":"#/components/schemas/Label","title":"Label"}}