@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

package/dist/docs/specifications/api/docs-cloud-f5-com.0130.public.ves.io.schema.implicit_label.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.implicit_label","description":"Implicit labels are attached to objects implicitly by the system. Users are not allowed to create/update/delete these labels\nThey are also not allowed to attach/detach these labels to objects. This API is provided to get the implicit labels available\nto be used in service-policies","version":""},"paths":{"/api/config/namespaces/system/implicit_labels":{"get":{"summary":"Get Implicit Labels","description":"Get is generic label query. Two types of queries are supported\n* Return label with exact matching entry label key = label value.\n* Return list of labels that have prefix of label key = label value.\nReturns list of labels. Query will look into current tenants shared namespace and ves-io shared.","operationId":"ves.io.schema.implicit_label.CustomAPI.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/implicit_labelGetResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"query","description":"Type of Query\n\nGet all available implicit labels\nGet exact match of label.key = label.value Or label.key(label.value)\nGet prefix match of label.key = label.value\nGet list of all keys\nGet list of all labels that exactly match the given key and substring match either 'value' or description provided in 'value' field\nGet list of all keys matching a substring","in":"query","required":false,"x-displayname":"Key Substring","schema":{"type":"string","enum":["QUERY_ALL_LABELS","QUERY_EXACT_LABEL","QUERY_VALUE_PREFIX_LABELS","QUERY_KEYS_ONLY","QUERY_VALUE_OR_DESCRIPTION_SUBSTRING","QUERY_KEY_SUBSTRING"],"default":"QUERY_ALL_LABELS"}},{"name":"key","description":"x-example: \"value\"\nKey string in Query parameters","in":"query","required":false,"x-displayname":"Key","schema":{"type":"string"}},{"name":"value","description":"x-example: \"value\"\nValue string in Query parameters","in":"query","required":false,"x-displayname":"Value","schema":{"type":"string"}},{"name":"key_classes","description":"x-example: \"key classes\"\nKey classes\n\nIncludes label keys with generic names such as \"my-key\", \"foobar-key\" etc.\nKeys that are obtained using GET on /api/config/namespaces/shared/known_label_keys\nIncludes volterra-defined known label keys such as \"ves.io/app_type\", \"ves.io/app\" and \"ves.io/siteType\" as well as tenant-defined known keys such as\n\"my-key\", \"acme-key-foo\" and \"acme-key-bar\". Note that tenant-defined known keys don't have any standard name format - they are known keys because they\nhave been explicitly created as known keys by the tenant and are stored in the configuration as known_label_keys.\nIncludes implicit geoip label keys \"geoip.ves.io/city\", \"geoip.ves.io/region\" and \"geoip.ves.io/country\"\nIncludes implicit label keys associated with packets/requests by the infrastructure e.g. \"implicit.ves.io/namespace\"\nInclude ip reputation label keys \"ipreputation.ves.io/threattype\", \"ipreputation.ves.io/threatlevel\"\nInclude url reputation label keys \"urlreputation.ves.io/category\", \"urlreputation.ves.io/reputationlevel\"\nIncludes implicit geoip label keys \"geoip.ves.io/continent\"\nIncludes implicit geoip label keys  \"geoip.ves.io/region\", \"geoip.ves.io/country\" and \"geoip.ves.io/continent\"\nImplicit aws resource labels (dynamically queried). This may be vpc level tags and/or subnet level tags","in":"query","required":false,"x-displayname":"Key Class AWS","explode":true,"schema":{"type":"array","items":{"type":"string","enum":["KEY_CLASS_GENERIC","KEY_CLASS_KNOWN","KEY_CLASS_GEOIP","KEY_CLASS_IMPLICIT","KEY_CLASS_IP_REPUTATION","KEY_CLASS_URL_REPUTATION","KEY_CLASS_GEOIP_EXTENDED","KEY_CLASS_DNS_GEOIP","KEY_CLASS_AWS"]}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-implicit_label-customapi-get"},"x-ves-proto-rpc":"ves.io.schema.implicit_label.CustomAPI.Get"},"x-displayname":"Implicit Label","x-ves-proto-service":"ves.io.schema.implicit_label.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Implicit Label","x-ves-proto-package":"ves.io.schema.implicit_label","components":{"schemas":{"implicit_labelGetResponse":{"type":"object","description":"Get Label Response, list of labels","title":"Get Label response","x-displayname":"Get Label Response","x-ves-proto-message":"ves.io.schema.implicit_label.GetResponse","properties":{"label":{"type":"array","description":" List of labels as Query response","title":"List of labels","items":{"$ref":"#/components/schemas/implicit_labelLabelType"},"x-displayname":"Labels"}}},"implicit_labelLabelType":{"type":"object","description":"Generic Label type label.key(label.value)","title":"Label Type","x-displayname":"Label","x-ves-proto-message":"ves.io.schema.implicit_label.LabelType","properties":{"description":{"type":"string","description":" Label description\n\nExample: ` \"description\"`","title":"description","x-displayname":"Description","x-ves-example":"description"},"key":{"type":"string","description":" Label key\n\nExample: ` \"key\"`","title":"key","x-displayname":"Key","x-ves-example":"key"},"value":{"type":"string","description":" Label value\n\nExample: ` \"value\"`","title":"value","x-displayname":"Value","x-ves-example":"value"}}},"implicit_labelQueryType":{"type":"string","description":"x-displayName: \"Label Query\"\nType of query for implicit labels\n\n - QUERY_ALL_LABELS: x-displayName: \"All Labels\"\nGet all available implicit labels\n - QUERY_EXACT_LABEL: x-displayName: \"Exact Label\"\nGet exact match of label.key = label.value Or label.key(label.value)\n - QUERY_VALUE_PREFIX_LABELS: x-displayName: \"Label Prefix\"\nGet prefix match of label.key = label.value\n - QUERY_KEYS_ONLY: x-displayName: \"Keys Only\"\nGet list of all keys\n - QUERY_VALUE_OR_DESCRIPTION_SUBSTRING: x-displayName: \"Value or Description Substring\"\nGet list of all labels that exactly match the given key and substring match either 'value' or description provided in 'value' field\n - QUERY_KEY_SUBSTRING: x-displayName: \"Key Substring\"\nGet list of all keys matching a substring","title":"Label Query type","enum":["QUERY_ALL_LABELS","QUERY_EXACT_LABEL","QUERY_VALUE_PREFIX_LABELS","QUERY_KEYS_ONLY","QUERY_VALUE_OR_DESCRIPTION_SUBSTRING","QUERY_KEY_SUBSTRING"],"default":"QUERY_ALL_LABELS"},"schemaLabelKeyClass":{"type":"string","description":"x-displayName: \"LabelKeyClass\"\nLabelKeyClass is an enumeration of supported label key classes\n\n - KEY_CLASS_GENERIC: x-displayName: \"Key Class Generic\"\nIncludes label keys with generic names such as \"my-key\", \"foobar-key\" etc.\n - KEY_CLASS_KNOWN: x-displayName: \"Key Class Known\"\nKeys that are obtained using GET on /api/config/namespaces/shared/known_label_keys\nIncludes volterra-defined known label keys such as \"ves.io/app_type\", \"ves.io/app\" and \"ves.io/siteType\" as well as tenant-defined known keys such as\n\"my-key\", \"acme-key-foo\" and \"acme-key-bar\". Note that tenant-defined known keys don't have any standard name format - they are known keys because they\nhave been explicitly created as known keys by the tenant and are stored in the configuration as known_label_keys.\n - KEY_CLASS_GEOIP: x-displayName: \"Key Class GeoIp\"\nIncludes implicit geoip label keys \"geoip.ves.io/city\", \"geoip.ves.io/region\" and \"geoip.ves.io/country\"\n - KEY_CLASS_IMPLICIT: x-displayName: \"Key Class Implicit\"\nIncludes implicit label keys associated with packets/requests by the infrastructure e.g. \"implicit.ves.io/namespace\"\n - KEY_CLASS_IP_REPUTATION: x-displayName: \"Key Class Reputation\"\nInclude ip reputation label keys \"ipreputation.ves.io/threattype\", \"ipreputation.ves.io/threatlevel\"\n - KEY_CLASS_URL_REPUTATION: x-displayName: \"Key Class URL Reputation\"\nInclude url reputation label keys \"urlreputation.ves.io/category\", \"urlreputation.ves.io/reputationlevel\"\n - KEY_CLASS_GEOIP_EXTENDED: x-displayName: \"Key Class GeoIp Extended\"\nIncludes implicit geoip label keys \"geoip.ves.io/continent\"\n - KEY_CLASS_DNS_GEOIP: x-displayName: \"Key Class DNS GeoIp\"\nIncludes implicit geoip label keys  \"geoip.ves.io/region\", \"geoip.ves.io/country\" and \"geoip.ves.io/continent\"\n - KEY_CLASS_AWS: x-displayName: \"Key Class AWS\"\nImplicit aws resource labels (dynamically queried). This may be vpc level tags and/or subnet level tags","title":"LabelKeyClass","enum":["KEY_CLASS_GENERIC","KEY_CLASS_KNOWN","KEY_CLASS_GEOIP","KEY_CLASS_IMPLICIT","KEY_CLASS_IP_REPUTATION","KEY_CLASS_URL_REPUTATION","KEY_CLASS_GEOIP_EXTENDED","KEY_CLASS_DNS_GEOIP","KEY_CLASS_AWS"],"default":"KEY_CLASS_GENERIC"}}}}

package/dist/docs/specifications/api/docs-cloud-f5-com.0131.public.ves.io.schema.infraprotect.ves-swagger.json

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.infraprotect","description":"APIs to get monitoring data for infraprotect.","version":""},"paths":{"/api/infraprotect/namespaces/system/infraprotect/access":{"get":{"summary":"Customer access","description":"RPC to get customer access and availability info.","operationId":"ves.io.schema.infraprotect.CustomGeneralAPI.CustomerAccess","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectCustomerAccessResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customgeneralapi-customeraccess"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomGeneralAPI.CustomerAccess"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomGeneralAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}":{"get":{"summary":"DDoS Alert","description":"RPC to get details of an alert.","operationId":"ves.io.schema.infraprotect.CustomAlertAPI.GetAlert","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectGetAlertResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"alert_id","description":"Alert ID\n\nx-example: \"12345\"\nID of the alert we want to get details for.","in":"path","required":true,"x-displayname":"Alert ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customalertapi-getalert"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomAlertAPI.GetAlert"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomAlertAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/alert/{alert_id}/to_event":{"put":{"summary":"Link Alert to Event","description":"Allows customers to link alerts with events. This helps with tracking of any mitigation activity and event investigation.","operationId":"ves.io.schema.infraprotect.CustomAlertAPI.AddAlertToEvent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectAddAlertToEventResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"alert_id","description":"Alert ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nAlert to be link with an event","in":"path","required":true,"x-displayname":"Alert ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectAddAlertToEventRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customalertapi-addalerttoevent"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomAlertAPI.AddAlertToEvent"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomAlertAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/alerts":{"post":{"summary":"DDoS Alerts","description":"RPC to get a list of Alerts. Alerts are raised when an attack is detected by L3/L4 provider.\nAlerts help to start investigate and mitigate any malicious or suspicious activate.","operationId":"ves.io.schema.infraprotect.CustomAlertAPI.ListAlerts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListAlertsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListAlertsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customalertapi-listalerts"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomAlertAPI.ListAlerts"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomAlertAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/infraprotect/bgp_peer_status":{"post":{"summary":"BGP Peer Status","description":"API to get routed DDoS BGP peer status information.","operationId":"ves.io.schema.infraprotect.CustomDataAPI.BGPPeerStatus","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectBGPPeerStatusResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectBGPPeerStatusRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customdataapi-bgppeerstatus"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomDataAPI.BGPPeerStatus"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}":{"get":{"summary":"Event details","description":"Returns details of an event. This allows customers to review any activity related to a DDoS attack.","operationId":"ves.io.schema.infraprotect.CustomEventAPI.GetEvent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectGetEventResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the event we want to get details for.","in":"path","required":true,"x-displayname":"Evemt ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-getevent"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.GetEvent"},"put":{"summary":"Edit event","description":"Allows editing of an event, setting its end date and upload any relevant pieces of information.","operationId":"ves.io.schema.infraprotect.CustomEventAPI.EditEvent","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectEditEventResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Alert ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the event we want to edit.","in":"path","required":true,"x-displayname":"Alert ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectEditEventRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-editevent"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.EditEvent"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/alerts":{"get":{"summary":"Event alerts","description":"Returns a list of alerts triggers while an event is active.","operationId":"ves.io.schema.infraprotect.CustomEventAPI.ListEventAlerts","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventAlertsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the event we want to get alerts for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-listeventalerts"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.ListEventAlerts"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/attachments":{"get":{"summary":"Event attachments","description":"Returns any attachments associated with an event. This could be Pcap files or any other document.\nObsolete - use `GetEvent` to list out attachments","operationId":"ves.io.schema.infraprotect.CustomEventAPI.ListEventAttachments","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventAttachmentsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the event we want to get attachments for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-listeventattachments"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.ListEventAttachments"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/detail/{event_detail_id}":{"delete":{"summary":"Delete event detail","description":"Delete a single event detail, including all dependant objects (e.g. attachments)","operationId":"ves.io.schema.infraprotect.CustomEventDetailsAPI.DeleteEventDetail","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectDeleteEventDetailResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent ID we want to delete the event detail for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}},{"name":"event_detail_id","description":"Event Detail ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent detail ID we want to delete.","in":"path","required":true,"x-displayname":"Event Detail ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventdetailsapi-deleteeventdetail"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventDetailsAPI.DeleteEventDetail"},"put":{"summary":"Edit event detail","description":"Allows editing of an event detail, setting its title, description and date","operationId":"ves.io.schema.infraprotect.CustomEventDetailsAPI.EditEventDetail","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectEditEventDetailResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent ID we want to edit the event detail for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}},{"name":"event_detail_id","description":"Event Detail ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent detail ID we want to update.","in":"path","required":true,"x-displayname":"Event Detail ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectEditEventDetailRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventdetailsapi-editeventdetail"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventDetailsAPI.EditEventDetail"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventDetailsAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/details":{"get":{"summary":"List of event details","description":"Returns a list of event details. The list contains event details entered by customer and the SOC team members, mitigation annotations and any attachments.","operationId":"ves.io.schema.infraprotect.CustomEventDetailsAPI.ListEventDetails","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventDetailsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent ID we want to list the event details for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventdetailsapi-listeventdetails"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventDetailsAPI.ListEventDetails"},"post":{"summary":"Add Event Detail","description":"Adds a single event detail to an event.","operationId":"ves.io.schema.infraprotect.CustomEventDetailsAPI.AddEventDetail","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectAddEventDetailResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"8094c17b-80c1-429d-8b17-7232f0e2937c\"\nEvent ID we want to list the event details for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectAddEventDetailRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventdetailsapi-addeventdetail"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventDetailsAPI.AddEventDetail"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventDetailsAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/event/{event_id}/mitigation_annotations":{"get":{"summary":"Event mitigation annotation","description":"Return mitigation annotations that occur while an event is active","operationId":"ves.io.schema.infraprotect.CustomEventAPI.ListEventMitigations","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventMitigationsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"event_id","description":"Event ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the event we want to get mitigations for.","in":"path","required":true,"x-displayname":"Event ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-listeventmitigations"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.ListEventMitigations"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/events":{"post":{"summary":"List of events","description":"Returns a list of events. Events are created when a high priority mitigation is started. Events then serve as a\none stop shop to review activities to mitigate a DDoS attack.","operationId":"ves.io.schema.infraprotect.CustomEventAPI.ListEvents","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-listevents"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.ListEvents"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/events_summary":{"get":{"summary":"Simple events view","description":"Return a list of available event (suitable for an alert)","operationId":"ves.io.schema.infraprotect.CustomEventAPI.ListEventsSummary","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListEventsSummaryResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"alert_id","description":"x-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nOptional - allows to filter events by alert so only relevant events are returned. If not provided, all user events are returned.","in":"query","required":false,"x-displayname":"Alert ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customeventapi-listeventssummary"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomEventAPI.ListEventsSummary"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomEventAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}":{"get":{"summary":"Mitigation details","description":"Returns details of a single mitigation","operationId":"ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigation","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectGetMitigationResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"mitigation_id","description":"Mitigation ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the mitigation we want to get the details for.","in":"path","required":true,"x-displayname":"Mitigation ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-custommitigationapi-getmitigation"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomMitigationAPI.GetMitigation"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomMitigationAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/annotations":{"get":{"summary":"Mitigation annotations","description":"Returns annotations of a single mitigation","operationId":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationAnnotations","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListMitigationAnnotationsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"mitigation_id","description":"Mitigation ID\n\nx-example: \"92d6e1e6-b6e9-46d4-9286-796a6b3fbf6a\"\nID of the mitigation we want to get the annotations for.","in":"path","required":true,"x-displayname":"Mitigation ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-custommitigationapi-listmitigationannotations"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationAnnotations"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomMitigationAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/mitigation/{mitigation_id}/ips":{"get":{"summary":"Mitigation IPs","description":"Returns list of IPs involved in a mitigation (and allows for searching through it)","operationId":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationIPs","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListMitigationIPsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"mitigation_id","description":"Mitigation ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the mitigation we want to get the IPs for.","in":"path","required":true,"x-displayname":"Mitigation ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-custommitigationapi-listmitigationips"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigationIPs"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomMitigationAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/mitigations":{"post":{"summary":"List of mitigations","description":"Returns a list of mitigations","operationId":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigations","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListMitigationsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListMitigationsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-custommitigationapi-listmitigations"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomMitigationAPI.ListMitigations"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomMitigationAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/networks":{"get":{"summary":"List networks","description":"Returns a list available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.","operationId":"ves.io.schema.infraprotect.CustomNetworkAPI.ListNetworks","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListNetworksResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customnetworkapi-listnetworks"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomNetworkAPI.ListNetworks"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomNetworkAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/report/{report_id}":{"get":{"summary":"Report details","description":"Returns details of a report, most importantly the PDF document itself.","operationId":"ves.io.schema.infraprotect.CustomReportAPI.GetReport","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectGetReportResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"report_id","description":"Report ID\n\nx-example: \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"\nID of the document we want to get the contents for.","in":"path","required":true,"x-displayname":"Report ID","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customreportapi-getreport"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomReportAPI.GetReport"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomReportAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/infraprotect/reports":{"post":{"summary":"List reports","description":"Returns a list of available reports to be downloaded. Reports summarise an event or a mitigation in a single PDF document.","operationId":"ves.io.schema.infraprotect.CustomReportAPI.ListReports","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListReportsResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"value\"\nThis request is supported only in system namespace.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectListReportsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customreportapi-listreports"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomReportAPI.ListReports"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomReportAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/infraprotect/transit_usage":{"post":{"summary":"Transit Usage","description":"API to get transit usage data.","operationId":"ves.io.schema.infraprotect.CustomDataAPI.TransitUsage","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectTransitUsageResponse"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"Namespace\n\nx-example: \"system\"","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectTransitUsageRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customdataapi-transitusage"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomDataAPI.TransitUsage"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomDataAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/infraprotect/namespaces/{namespace}/suggest-values":{"post":{"summary":"Suggest Values","description":"SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.","operationId":"ves.io.schema.infraprotect.CustomGeneralAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemainfraprotectSuggestValuesResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/infraprotectSuggestValuesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-infraprotect-customgeneralapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.infraprotect.CustomGeneralAPI.SuggestValues"},"x-displayname":"Infraprotect","x-ves-proto-service":"ves.io.schema.infraprotect.CustomGeneralAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Infraprotect","x-ves-proto-package":"ves.io.schema.infraprotect","components":{"schemas":{"infraprotectAccessFlag":{"type":"object","description":"Single access flag instance","title":"Single access flag instance","x-displayname":"Access flag","x-ves-proto-message":"ves.io.schema.infraprotect.AccessFlag","properties":{"data_expected_ts":{"type":"string","description":" if set then it indicates the date when we expect the customer to have data present\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Data expected","format":"date-time","x-displayname":"Data expected","x-ves-example":"2021-01-01T00:00:00Z"},"data_present":{"type":"boolean","description":" if true then the customer has some data available, otherwise no data available","title":"Data present","format":"boolean","x-displayname":"Data present"},"enabled":{"type":"boolean","description":" if true then the customer has this feature enabled","title":"Enabled","format":"boolean","x-displayname":"Enabled"}}},"infraprotectAddAlertToEventRequest":{"type":"object","description":"Request to add an alert to event (link them together)","title":"Add Alert to Event","x-displayname":"Add Alert to Event","x-ves-proto-message":"ves.io.schema.infraprotect.AddAlertToEventRequest","properties":{"alert_id":{"type":"string","description":" Alert to be link with an event\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Alert ID","x-displayname":"Alert ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"event_id":{"type":"string","description":" Event to be link with an alert\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Event ID","x-displayname":"Event ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"infraprotectAddAlertToEventResponse":{"type":"object","description":"Response to adding an alert to event","title":"Add Alert to Event","x-displayname":"Add Alert to Event","x-ves-proto-message":"ves.io.schema.infraprotect.AddAlertToEventResponse"},"infraprotectAddEventDetailRequest":{"type":"object","description":"Request to add a single event detail to an event","title":"Request to add event detail","x-displayname":"Add event detail request","x-ves-proto-message":"ves.io.schema.infraprotect.AddEventDetailRequest","properties":{"attachments":{"type":"array","description":" All attachments on an event details","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"},"description":{"type":"string","description":" Description of the event detail\n\nExample: ` \"Actions taken...\"`","title":"Description","x-displayname":"Description","x-ves-example":"Actions taken: ..."},"event_id":{"type":"string","description":" Event ID we want to list the event details for.\n\nExample: ` \"8094c17b-80c1-429d-8b17-7232f0e2937c\"`","title":"Event ID","x-displayname":"Event ID","x-ves-example":"8094c17b-80c1-429d-8b17-7232f0e2937c"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"time":{"type":"string","description":" Time of the event detail\n Format: RFC3339\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Time","format":"date-time","x-displayname":"Time","x-ves-example":"2021-01-01T00:00:00Z"},"title":{"type":"string","description":" Title of the event of the event detail\n\nExample: ` \"Actions taken so far\"`","title":"Title","x-displayname":"Title","x-ves-example":"Actions taken so far"}}},"infraprotectAddEventDetailResponse":{"type":"object","description":"Event detail as stored in the backend","title":"Event detail as stored","x-displayname":"Event detail as stored","x-ves-proto-message":"ves.io.schema.infraprotect.AddEventDetailResponse","properties":{"detail":{"$ref":"#/components/schemas/infraprotectEventDetail"}}},"infraprotectAlert":{"type":"object","description":"Detail of an alert.","title":"Alert detail","x-displayname":"Alert detail","x-ves-proto-message":"ves.io.schema.infraprotect.Alert","properties":{"arbor_id":{"type":"string","description":" L3/L4 provider alert identifier\n\nExample: ` \"1323975\"`","title":"L3/L4 ID","x-displayname":"L3/L4 ID","x-ves-example":"1323975"},"bandwidth":{"type":"string","description":" Bandwidth that triggered the alert in BPS.\n\nExample: ` \"10000000\"`","title":"Bandwidth","format":"int64","x-displayname":"Bandwidth","x-ves-example":"10000000"},"creator":{"type":"string","description":" Creator of the alert (or SOC if created manually)","title":"Creator","x-displayname":"Creator"},"end_time":{"type":"string","description":" End time of the alert. This is when the threshold was restored.\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-example":"2021-01-01T00:00:00Z"},"events":{"type":"array","description":" List of associated alerts. These alerts are normally manually associated.","title":"Events","items":{"$ref":"#/components/schemas/infraprotectEvent"},"x-displayname":"Events"},"id":{"type":"string","description":" ID of the alert used to uniquely identify it.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Id","x-displayname":"Id","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"ip":{"type":"string","description":" IP the alert is triggered for. This is the \"protected\" IP\n\nExample: ` \"127.0.0.1\"`","title":"IP address","x-displayname":"IP address","x-ves-example":"127.0.0.1"},"network_id":{"type":"string","description":" Network the alert is related to","title":"Network ID","x-displayname":"Network ID"},"source_type":{"$ref":"#/components/schemas/infraprotectAlertSourceType"},"start_time":{"type":"string","description":" Start time of the alert. This is when a threshold was exceeded.\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-example":"2021-01-01T00:00:00Z"},"type":{"type":"string","description":" Type of the alert, e.g. DoS host alert\n\nExample: ` \"DoS host alert\"`","title":"Alert type","x-displayname":"Alert type","x-ves-example":"DoS host alert"}}},"infraprotectAlertPort":{"type":"object","description":"Single occurrence of a port in an alert","title":"Alert port","x-displayname":"Alert port","x-ves-proto-message":"ves.io.schema.infraprotect.AlertPort","properties":{"bytes":{"type":"string","description":" Bytes received on the port.\n\nExample: ` \"12345\"`","title":"Bytes","format":"int64","x-displayname":"Bytes","x-ves-example":"12345"},"destination":{"type":"boolean","description":" Destination flag - if rue then the port field is the destination of the alert.","title":"Destination","format":"boolean","x-displayname":"Destination"},"name":{"type":"string","description":" Logical name of the port.\n\nExample: ` \"HTTPS\"`","title":"Name","x-displayname":"Name","x-ves-example":"HTTPS"},"number":{"type":"integer","description":" Port number involved in the alert.\n\nExample: ` \"8080\"`","title":"Port number","format":"int32","x-displayname":"Port number","x-ves-example":"8080"},"packets":{"type":"string","description":" Packets received on the port.\n\nExample: ` \"12345\"`","title":"packets","format":"int64","x-displayname":"Packets","x-ves-example":"12345"},"protocol":{"type":"string","description":" Protocol used on the port.\n\nExample: ` \"UDP\"`","title":"Protocol","x-displayname":"Protocol","x-ves-example":"UDP"}}},"infraprotectAlertPrefix":{"type":"object","description":"Single occurrence of a prefix in an alert","title":"Alert prefix","x-displayname":"Alert prefix","x-ves-proto-message":"ves.io.schema.infraprotect.AlertPrefix","properties":{"cidr":{"type":"string","description":" Cidr of the alert source\n\nExample: ` \"127.0.0.1/0\"`","title":"Cidr","x-displayname":"Cidr","x-ves-example":"127.0.0.1/0"},"destination":{"type":"boolean","description":" Destination flag - if rue then the Cidr field is the destination of the alert.","title":"Destination","format":"boolean","x-displayname":"Destination"},"num_bytes":{"type":"string","description":" Bytes received on the Cidr.\n\nExample: ` \"12345\"`","title":"Bytes","format":"int64","x-displayname":"Bytes","x-ves-example":"12345"},"num_packets":{"type":"string","description":" Packets received on the Cidr.\n\nExample: ` \"12345\"`","title":"Packets","format":"int64","x-displayname":"Packets","x-ves-example":"12345"}}},"infraprotectAlertSourceType":{"type":"string","description":"Alert source type - helps the UI distinguish alerts coming from different sources\n\n - ALERT_SOURCE_TYPE_UNKNOWN: Unspecified source type\n - ALERT_SOURCE_TYPE_MITIGATED: Alert is sourced from a mitigated-type system\n - ALERT_SOURCE_TYPE_AUTOMITIGATED: Alert is sourced from an automitigated-type system","title":"Alert source type","enum":["ALERT_SOURCE_TYPE_UNKNOWN","ALERT_SOURCE_TYPE_MITIGATED","ALERT_SOURCE_TYPE_AUTOMITIGATED"],"default":"ALERT_SOURCE_TYPE_UNKNOWN","x-displayname":"Alert source type","x-ves-proto-enum":"ves.io.schema.infraprotect.AlertSourceType"},"infraprotectAttachment":{"type":"object","description":"Event attachment record (pcap, or any arbitrary file)","title":"Event attachment","x-displayname":"Event attachment","x-ves-proto-message":"ves.io.schema.infraprotect.Attachment","properties":{"attachment_id":{"type":"string","description":" ID of the attachment\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Attachment ID","x-displayname":"Attachment ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"attachment_type":{"$ref":"#/components/schemas/infraprotectAttachmentType"},"end_time":{"type":"string","description":" End time as an RFC3339 string\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End time","x-ves-example":"2021-01-01T00:00:00Z"},"gos_name":{"type":"string","description":" Generic object storage name of the attachment\n\nExample: ` \"attachment_123\"`","title":"GOS name","x-displayname":"GOS name","x-ves-example":"attachment_123"},"gos_version":{"type":"string","description":" Generic object storage version of the attachment\n\nExample: ` \"v01-00-00-00\"`","title":"GOS version","x-displayname":"GOS version","x-ves-example":"v01-00-00-00"},"name":{"type":"string","description":" Name of the attachment\n\nExample: ` \"last_pcap.file\"`","title":"Name","x-displayname":"Name","x-ves-example":"last_pcap.file"},"size_bytes":{"type":"string","description":" Size of the attachment\n\nExample: ` \"12345\"`","title":"Size","format":"int64","x-displayname":"Size","x-ves-example":"12345"},"start_time":{"type":"string","description":" Start time as an RFC3339 string\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectAttachmentType":{"type":"string","description":"Attachment type - helps the UI to properly handle attachments as not all attachment cna be treated the same\n\n - ATTACHMENT_TYPE_UNKNOWN: Unspecified attachment\n - ATTACHMENT_TYPE_PCAP: Attachment is a PCAP file\n - ATTACHMENT_TYPE_BINARY: Attachment is a binary file\n - ATTACHMENT_TYPE_INVALID_PCAP: Attachment type indicated as, however the file format is different\n - ATTACHMENT_TYPE_OTHER: Attachment is other than above","title":"Attachment type","enum":["ATTACHMENT_TYPE_UNKNOWN","ATTACHMENT_TYPE_PCAP","ATTACHMENT_TYPE_BINARY","ATTACHMENT_TYPE_INVALID_PCAP","ATTACHMENT_TYPE_OTHER"],"default":"ATTACHMENT_TYPE_UNKNOWN","x-displayname":"Attachment type","x-ves-proto-enum":"ves.io.schema.infraprotect.AttachmentType"},"infraprotectBGPPeerStatusItem":{"type":"object","description":"Routed DDoS BGP peer status data specific to a given router/peer combination","title":"BGP Peer Status Item","x-displayname":"BGP Peer Status Item","x-ves-proto-message":"ves.io.schema.infraprotect.BGPPeerStatusItem","properties":{"asn":{"type":"integer","description":" Autonomous System Number for BGP peer\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 1\n","title":"ASN","format":"int64","x-displayname":"ASN","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"1"}},"bgp_peer_address":{"$ref":"#/components/schemas/schemaIpAddressType"},"device_location":{"$ref":"#/components/schemas/infraprotectDeviceLocation"},"last_established":{"type":"string","format":"date-time"},"session_state":{"$ref":"#/components/schemas/infraprotectBgpPeerSessionState"}}},"infraprotectBGPPeerStatusRequest":{"type":"object","description":"Request to get routed DDoS BGP peer status information","title":"BGP Peer Status Request","x-displayname":"BGP Peer Status Request","x-ves-proto-message":"ves.io.schema.infraprotect.BGPPeerStatusRequest","properties":{"namespace":{"type":"string","description":"\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"time":{"type":"string","description":" Timestamp at which the snapshot of the bgp peer status data should be fetched.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated  to <current time>\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Time","x-displayname":"Time","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"infraprotectBGPPeerStatusResponse":{"type":"object","description":"Routed DDoS BGP peer status response data","title":"BGP Peer Status Response","x-displayname":"BGP Peer Status Response","x-ves-proto-message":"ves.io.schema.infraprotect.BGPPeerStatusResponse","properties":{"items":{"type":"array","description":" BGP Peer Status Items contains routed DDoS BGP peer status data for each router/peer combination","title":"BGP Peer Status Items","items":{"$ref":"#/components/schemas/infraprotectBGPPeerStatusItem"},"x-displayname":"BGP Peer Status Items"}}},"infraprotectBgpPeerSessionState":{"type":"string","description":"Status of BGP connection to this Peer\n\nConnection state is Idle\nConnection state is Connecting\nConnection state is Active\nConnection state is Open Sent\nConnection state is Open Confirm\nConnection state is Established","title":"BGP Peer Session State","enum":["Idle","Connect","Active","OpenSent","OpenConfirm","Established"],"default":"Idle","x-displayname":"BGP Peer Status","x-ves-proto-enum":"ves.io.schema.infraprotect.BgpPeerSessionState"},"infraprotectCustomerAccessResponse":{"type":"object","description":"Infraprotect and L3/L4 ddos accessibility and availability flags response.","title":"Response to get customer access flags","x-displayname":"Customer access flags","x-ves-proto-message":"ves.io.schema.infraprotect.CustomerAccessResponse","properties":{"l3l4":{"$ref":"#/components/schemas/infraprotectAccessFlag"}}},"infraprotectDeleteEventDetailResponse":{"type":"object","description":"Event detail deletion response message.","title":"Event detail deletion response","x-displayname":"Event detail deletion response","x-ves-proto-message":"ves.io.schema.infraprotect.DeleteEventDetailResponse"},"infraprotectDeviceLocation":{"type":"object","description":"Location of a network device (aka router) where DDoS transit tunnels are provisioned","title":"Device Location","x-displayname":"Device Location","x-ves-oneof-field-zone":"[\"zone1\",\"zone2\"]","x-ves-proto-message":"ves.io.schema.infraprotect.DeviceLocation","properties":{"name":{"type":"string","description":" Device location name\n\nExample: ` \"ves-io-seattle\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_len: 256\n","title":"Location Name","maxLength":256,"x-displayname":"Location Name","x-ves-example":"ves-io-seattle","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}},"zone1":{"$ref":"#/components/schemas/schemaEmpty"},"zone2":{"$ref":"#/components/schemas/schemaEmpty"}}},"infraprotectEditEventDetailRequest":{"type":"object","description":"Request to update a single event detail","title":"Request to update event detail","x-displayname":"Update event detail request","x-ves-proto-message":"ves.io.schema.infraprotect.EditEventDetailRequest","properties":{"attachments":{"type":"array","description":" All attachments on an event details, missing will be removed, extras will be added","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"},"description":{"type":"string","description":" Description of the event detail\n\nExample: ` \"Actions taken...\"`","title":"Description","x-displayname":"Description","x-ves-example":"Actions taken: ..."},"event_detail_id":{"type":"string","description":" Event detail ID we want to update.\n\nExample: ` \"8094c17b-80c1-429d-8b17-7232f0e2937c\"`","title":"Event Detail ID","x-displayname":"Event Detail ID","x-ves-example":"8094c17b-80c1-429d-8b17-7232f0e2937c"},"event_id":{"type":"string","description":" Event ID we want to edit the event detail for.\n\nExample: ` \"8094c17b-80c1-429d-8b17-7232f0e2937c\"`","title":"Event ID","x-displayname":"Event ID","x-ves-example":"8094c17b-80c1-429d-8b17-7232f0e2937c"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"time":{"type":"string","description":" Time of the event detail\n Format: RFC3339\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Time","format":"date-time","x-displayname":"Time","x-ves-example":"2021-01-01T00:00:00Z"},"title":{"type":"string","description":" Title of the event of the event detail\n\nExample: ` \"Actions taken so far\"`","title":"Title","x-displayname":"Title","x-ves-example":"Actions taken so far"}}},"infraprotectEditEventDetailResponse":{"type":"object","description":"Event detail as stored in the backend","title":"Event detail as stored","x-displayname":"Event detail as stored","x-ves-proto-message":"ves.io.schema.infraprotect.EditEventDetailResponse","properties":{"detail":{"$ref":"#/components/schemas/infraprotectEventDetail"}}},"infraprotectEditEventRequest":{"type":"object","description":"Request to get a single event","title":"Event request","x-displayname":"Event request","x-ves-proto-message":"ves.io.schema.infraprotect.EditEventRequest","properties":{"description":{"type":"string","description":" New description of the event\n\nExample: ` \"New description of the event\"`","title":"Description","x-displayname":"Description","x-ves-example":"New description of the event"},"end_time":{"type":"string","description":" New end time of the event (note that end time is always set manually)\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End time","x-ves-example":"2021-01-01T00:00:00Z"},"event_attachments":{"type":"array","description":" List of event's attachments","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"},"event_id":{"type":"string","description":" ID of the event we want to edit.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Alert ID","x-displayname":"Alert ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"name":{"type":"string","description":" New name of the event\n\nExample: ` \"event_123\"`","title":"Name","x-displayname":"Name","x-ves-example":"event_123"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"infraprotectEditEventResponse":{"type":"object","description":"Updated event as a response to an event editing","title":"Edit event response","x-displayname":"Edit event response","x-ves-proto-message":"ves.io.schema.infraprotect.EditEventResponse","properties":{"event":{"$ref":"#/components/schemas/infraprotectEvent"}}},"infraprotectEvent":{"type":"object","description":"Event (an attack record) that holds info an attack and its mitigation(s)","title":"Single instance of an event","x-displayname":"Event","x-ves-proto-message":"ves.io.schema.infraprotect.Event","properties":{"attachments":{"type":"array","description":" Attachments on an event","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"},"creator":{"type":"string","description":" Creator of the event\n\nExample: ` \"SOC\"`","title":"Creator","x-displayname":"Creator","x-ves-example":"SOC"},"description":{"type":"string","description":" More detailed description of the event. Most of the time list of actions taken.\n\nExample: ` \"[object_name1, object_name2]\"`","title":"Description","x-displayname":"Description","x-ves-example":"[object_name1, object_name2]"},"end_time":{"type":"string","description":" End time as an RFC3339 string\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End time","x-ves-example":"2021-01-01T00:00:00Z"},"has_attachment":{"type":"boolean","description":" True if event has any attachment other than PCAP files","title":"Has attachment","format":"boolean","x-displayname":"Has attachment"},"has_details":{"type":"boolean","description":" True if the event already has details assigned, otherwise false","title":"Has details","format":"boolean","x-displayname":"Has details"},"id":{"type":"string","description":" ID of the event used to uniquely identify it.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Id","x-displayname":"Id","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"ip":{"type":"string","description":" Target IP\n\nExample: ` \"192.168.0.0/0\"`","title":"IP","x-displayname":"IP","x-ves-example":"192.168.0.0/0"},"mitigation_id":{"type":"string","description":" Mitigation the event is related to\n\nExample: ` \"uuid-12345-56789\"`","title":"Mitigation ID","x-displayname":"Mitigation ID","x-ves-example":"uuid-12345-56789"},"name":{"type":"string","description":" Name of an event\n\nExample: ` \"mainnet_1234_2022\"`","title":"Name","x-displayname":"Name","x-ves-example":"mainnet_1234_2022"},"network_id":{"type":"string","description":" Network the event is related to\n\nExample: ` \"uuid-12345-56789\"`","title":"Network ID","x-displayname":"Network ID","x-ves-example":"uuid-12345-56789"},"start_time":{"type":"string","description":" Start time as an RFC3339 string\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectEventDetail":{"type":"object","description":"Event detail represents a single occurrence of event detail, that tracks customer, SOC notes on a given event.","title":"Event detail","x-displayname":"Event detail","x-ves-proto-message":"ves.io.schema.infraprotect.EventDetail","properties":{"attachments":{"type":"array","description":" All attachments on an event details","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"},"creator":{"type":"string","description":" Creator of the event detail\n\nExample: ` \"SOC\"`","title":"Creator","x-displayname":"Creator","x-ves-example":"SOC"},"description":{"type":"string","description":" Textual description of the event detail record\n\nExample: ` \"List of actions taken so far ...\"`","title":"Description","x-displayname":"Description","x-ves-example":"List of actions taken so far ..."},"id":{"type":"string","description":" ID of the event detail used to uniquely identify it.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Id","x-displayname":"Id","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"time":{"type":"string","description":" Time the event details applies to. Details can be added retrospectively this fields allow pin point to detail to a specific time. The value must fall within the event time range.\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Time","format":"date-time","x-displayname":"Time","x-ves-example":"2021-01-01T00:00:00Z"},"title":{"type":"string","description":" Title of the event detail\n\nExample: ` \"Additional details\"`","title":"Title","x-displayname":"Title","x-ves-example":"Additional details"}}},"infraprotectEventSummary":{"type":"object","description":"Simplified view of an event","title":"Simplified event","x-displayname":"Simplified event","x-ves-proto-message":"ves.io.schema.infraprotect.EventSummary","properties":{"id":{"type":"string","description":" Event ID\n\nExample: ` \"12345\"`","title":"ID","x-displayname":"ID","x-ves-example":"12345"},"name":{"type":"string","description":" Name of the event (to be displayed to the customer)\n\nExample: ` \"event_12345_2022\"`","title":"Name","x-displayname":"Name","x-ves-example":"event_12345_2022"}}},"infraprotectGetAlertResponse":{"type":"object","description":"Response to the single alert request","title":"Alert response","x-displayname":"Alert response","x-ves-proto-message":"ves.io.schema.infraprotect.GetAlertResponse","properties":{"ports":{"type":"array","description":" List of ports involved in the alert","title":"Ports","items":{"$ref":"#/components/schemas/infraprotectAlertPort"},"x-displayname":"Ports"},"prefixes":{"type":"array","description":" List of prefixes involved in the alert","title":"Prefixes","items":{"$ref":"#/components/schemas/infraprotectAlertPrefix"},"x-displayname":"Prefixes"}}},"infraprotectGetEventResponse":{"type":"object","description":"Response to get a single event","title":"Event response","x-displayname":"Event response","x-ves-proto-message":"ves.io.schema.infraprotect.GetEventResponse","properties":{"event":{"$ref":"#/components/schemas/infraprotectEvent"}}},"infraprotectGetMitigationResponse":{"type":"object","description":"Details of a mitigation","title":"Mitigation response","x-displayname":"Mitigation response","x-ves-proto-message":"ves.io.schema.infraprotect.GetMitigationResponse","properties":{"details":{"type":"string","description":" Base64 encoded document with mitigation details. The document resembles HTML and should be displayed as such.\n\nExample: ` \"\"`","title":"Details","format":"byte","x-displayname":"Details"},"prefixes":{"type":"array","description":" Prefixes associated to mitigation\n\nExample: ` \"192.168.0.0/32 192.168.0.1/32\"`","title":"Prefixes","items":{"type":"string"},"x-displayname":"Prefixes","x-ves-example":"192.168.0.0/32 192.168.0.1/32"}}},"infraprotectGetReportResponse":{"type":"object","description":"Single report document content","title":"Report response","x-displayname":"Report response","x-ves-proto-message":"ves.io.schema.infraprotect.GetReportResponse","properties":{"attachment":{"$ref":"#/components/schemas/infraprotectAttachment"}}},"infraprotectListAlertsRequest":{"type":"object","description":"Request to get customer alerts with optional filtering","title":"Alerts request","x-displayname":"Alerts request","x-ves-proto-message":"ves.io.schema.infraprotect.ListAlertsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: RFC3339\n\n Optional: If not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-example":"2021-01-01T00:00:00Z"},"event_id":{"type":"string","description":" Event ID when we want to filter by an event start and end time.\n\n Optional: If not specified, then no events filtering occurs\n\nExample: ` \"12345\"`","title":"Event ID","x-displayname":"Event ID","x-ves-example":"12345"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"network_id":{"type":"string","description":" Network ID when we want to filter by a network. It is assured that the network belongs to the tenant.\n\n Optional: If not specified, then no network filtering occurs\n\nExample: ` \"12345\"`","title":"Network ID","x-displayname":"Network ID","x-ves-example":"12345"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: RFC3339\n\n Optional: If not specified, then the start_time will be evaluated to <current time>-3d\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectListAlertsResponse":{"type":"object","description":"Response to the alerts request","title":"Alerts response","x-displayname":"Alerts response","x-ves-proto-message":"ves.io.schema.infraprotect.ListAlertsResponse","properties":{"alerts":{"type":"array","description":" List if alerts","title":"Alerts","items":{"$ref":"#/components/schemas/infraprotectAlert"},"x-displayname":"Alerts"}}},"infraprotectListEventAlertsResponse":{"type":"object","description":"Response, list of alerts associated with an event","title":"Event alerts response","x-displayname":"Event alerts response","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventAlertsResponse","properties":{"alerts":{"type":"array","description":" List of alerts related to the event.","title":"Alerts","items":{"$ref":"#/components/schemas/infraprotectAlert"},"x-displayname":"Alerts"}}},"infraprotectListEventAttachmentsResponse":{"type":"object","description":"Response, list of attachments associated with an event","title":"Event attachments response","x-displayname":"Event attachments response","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventAttachmentsResponse","properties":{"attachments":{"type":"array","description":" List of Attachments related to the event.","title":"Attachments","items":{"$ref":"#/components/schemas/infraprotectAttachment"},"x-displayname":"Attachments"}}},"infraprotectListEventDetailsResponse":{"type":"object","description":"All details of the event","title":"List event details response","x-displayname":"List event details response","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventDetailsResponse","properties":{"details":{"type":"array","description":" List of event details the event may have.","title":"Event details","items":{"$ref":"#/components/schemas/infraprotectEventDetail"},"x-displayname":"Event details"}}},"infraprotectListEventMitigationsResponse":{"type":"object","description":"Response, list of mitigations associated with an event","title":"Event mitigations response","x-displayname":"Event mitigations response","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventMitigationsResponse","properties":{"mitigations":{"type":"array","description":" List of mitigations related to the event.","title":"Mitigations","items":{"$ref":"#/components/schemas/infraprotectMitigationAnnotation"},"x-displayname":"Mitigations"}}},"infraprotectListEventsRequest":{"type":"object","description":"Request to get a list of events","title":"List of events request","x-displayname":"Events","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: RFC3339\n\n Optional: If not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-example":"2021-01-01T00:00:00Z"},"mitigation_id":{"type":"string","description":" Filter events by mitigation\n\n Optional: If not specified, then events are returned regardless of mitigation.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Mitigation","x-displayname":"Mitigation","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"network_id":{"type":"string","description":" Filter events by network\n\n Optional: If not specified, then all tenant's networks are considerate.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Network","x-displayname":"Network","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: RFC3339\n\n Optional: If not specified, then the start_time will be evaluated to <current time>-3d\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectListEventsResponse":{"type":"object","description":"Response to get a list of events","title":"List of events response","x-displayname":"Events","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventsResponse","properties":{"events":{"type":"array","description":" Recorder events filtered by events requests","title":"Events","items":{"$ref":"#/components/schemas/infraprotectEvent"},"x-displayname":"Events"}}},"infraprotectListEventsSummaryResponse":{"type":"object","description":"Response to the simplified events view request","title":"Simplified events response","x-displayname":"Simplified events response","x-ves-proto-message":"ves.io.schema.infraprotect.ListEventsSummaryResponse","properties":{"events":{"type":"array","description":" List of events","title":"Events","items":{"$ref":"#/components/schemas/infraprotectEventSummary"},"x-displayname":"Events"}}},"infraprotectListMitigationAnnotationsResponse":{"type":"object","description":"List of mitigation annotations (i.e. mitigation notes sorted chronologically)","title":"Mitigation annotations response","x-displayname":"Mitigation annotations response","x-ves-proto-message":"ves.io.schema.infraprotect.ListMitigationAnnotationsResponse","properties":{"annotations":{"type":"array","description":" Mitigation annotations of a mitigation\n\nExample: ` \"['done this', 'done that']\"`","title":"Annotations","items":{"$ref":"#/components/schemas/infraprotectMitigationAnnotation"},"x-displayname":"Annotations","x-ves-example":"['done this', 'done that']"}}},"infraprotectListMitigationIPsResponse":{"type":"object","description":"List of mitigation Ips","title":"Mitigation IPs response","x-displayname":"Mitigation IPs response","x-ves-proto-message":"ves.io.schema.infraprotect.ListMitigationIPsResponse","properties":{"ips":{"type":"array","description":" List of IP addresses along with log count.","title":"IPs","items":{"$ref":"#/components/schemas/infraprotectMitigationIP"},"x-displayname":"IPs"}}},"infraprotectListMitigationsRequest":{"type":"object","description":"Request to get a list of mitigations","title":"Mitigations request","x-displayname":"Mitigations request","x-ves-proto-message":"ves.io.schema.infraprotect.ListMitigationsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: RFC3339 string\n\n Optional: If not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-example":"2021-01-01T00:00:00Z"},"event_id":{"type":"string","description":" Filter mitigations by an event\n\n Optional: If not specified, then all tenant's events are considerate.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Event","x-displayname":"Event","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"network_id":{"type":"string","description":" Filter mitigations by network\n\n Optional: If not specified, then all tenant's networks are considerate.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Network","x-displayname":"Network","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: RFC3339 string\n\n Optional: If not specified, then the start_time will be evaluated to <current time>-3d\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectListMitigationsResponse":{"type":"object","description":"Response giving a list of mitigations","title":"Mitigations response","x-displayname":"Mitigations response","x-ves-proto-message":"ves.io.schema.infraprotect.ListMitigationsResponse","properties":{"mitigations":{"type":"array","description":" Filtered mitigations","title":"Mitigations","items":{"$ref":"#/components/schemas/infraprotectMitigation"},"x-displayname":"Mitigations"}}},"infraprotectListNetworksResponse":{"type":"object","description":"Response containing all networks available to the customer","title":"Networks response","x-displayname":"Networks response","x-ves-proto-message":"ves.io.schema.infraprotect.ListNetworksResponse","properties":{"networks":{"type":"array","description":" List of networks the customer has.","title":"Networks","items":{"$ref":"#/components/schemas/infraprotectNetwork"},"x-displayname":"Networks"}}},"infraprotectListReportsRequest":{"type":"object","description":"Request to get a list of available reports","title":"Reports request","x-displayname":"Reports request","x-ves-proto-message":"ves.io.schema.infraprotect.ListReportsRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: RFC3339 string\n\n Optional: If not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End Time","x-ves-example":"2021-01-01T00:00:00Z"},"namespace":{"type":"string","description":" This request is supported only in system namespace.\n\nExample: ` \"value\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"value"},"start_time":{"type":"string","description":" start time of metric collection from which data will be considered to build graph.\n Format: RFC3339 string\n\n Optional: If not specified, then the start_time will be evaluated to <current time>-3d\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start Time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectListReportsResponse":{"type":"object","description":"List of available reports","title":"Reports response","x-displayname":"Reports response","x-ves-proto-message":"ves.io.schema.infraprotect.ListReportsResponse","properties":{"reports":{"type":"array","description":" List of reports available to the tenant","title":"Reports","items":{"$ref":"#/components/schemas/infraprotectReport"},"x-displayname":"Reports"}}},"infraprotectMitigation":{"type":"object","description":"Mitigation details","title":"Mitigation","x-displayname":"Mitigation","x-ves-proto-message":"ves.io.schema.infraprotect.Mitigation","properties":{"arbor_id":{"type":"string","description":" L3/L4 provider identity string\n\nExample: ` \"tms-123\"`","title":"L3/L4 ID","x-displayname":"L3/L4 ID","x-ves-example":"tms-123"},"creator":{"type":"string","description":" Creator of the alert (or SOC if created manually)","title":"Creator","x-displayname":"Creator"},"end_time":{"type":"string","description":" RFC3339 string of the mitigation end time\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"End time","format":"date-time","x-displayname":"End time","x-ves-example":"2021-01-01T00:00:00Z"},"id":{"type":"string","description":" Mitigation ID\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"ID","x-displayname":"ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"is_ongoing":{"type":"boolean","description":" True if the mitigation is still ongoing","title":"Ongoing","format":"boolean","x-displayname":"ongoing"},"name":{"type":"string","description":" Mitigation name\n\nExample: ` \"dosproof_123\"`","title":"Name","x-displayname":"Name","x-ves-example":"dosproof_123"},"network_id":{"type":"string","description":" ID of the network involved in the mitigation","title":"NetworkID","x-displayname":"Network ID"},"network_name":{"type":"string","description":" Name of the network involved in the mitigation\n\nExample: ` \"dosproof_123\"`","title":"Network","x-displayname":"Network","x-ves-example":"dosproof_123"},"offramp":{"type":"string","description":" Offramp related to the mitigation\n\nExample: ` \"192.168.0.1/32\"`","title":"Offramp","x-displayname":"Offramp","x-ves-example":"192.168.0.1/32"},"start_time":{"type":"string","description":" RFC3339 string of the mitigation start time\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Start time","format":"date-time","x-displayname":"Start time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectMitigationAnnotation":{"type":"object","description":"Mitigation annotation","title":"MitigationAnnotation","x-displayname":"MitigationAnnotation","x-ves-proto-message":"ves.io.schema.infraprotect.MitigationAnnotation","properties":{"annotation":{"type":"string","description":" Annotation text\n\nExample: ` \"Annotation 1\"`","title":"Annotation","x-displayname":"Annotation","x-ves-example":"Annotation 1"},"creator":{"type":"string","description":" Annotation creator\n\nExample: ` \"user1\"`","title":"Creator","x-displayname":"Creator","x-ves-example":"user1"},"id":{"type":"string","description":" Mitigation ID\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"ID","x-displayname":"ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"time":{"type":"string","description":" Annotation creation time as an RFC3339 string\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Time","format":"date-time","x-displayname":"Time","x-ves-example":"2021-01-01T00:00:00Z"}}},"infraprotectMitigationIP":{"type":"object","description":"A single mitigation IP record including log record count","title":"Mitigation IP record","x-displayname":"Mitigation IP record","x-ves-proto-message":"ves.io.schema.infraprotect.MitigationIP","properties":{"ip":{"type":"string","description":" Mitigation source IP\n\nExample: ` \"192.168.0.0/0\"`","title":"IP","x-displayname":"IP","x-ves-example":"192.168.0.0/0"},"log_count":{"type":"string","description":" Number of times the IP appears in the log\n\nExample: ` \"123\"`","title":"Log count","format":"int64","x-displayname":"Log count","x-ves-example":"123"}}},"infraprotectNetwork":{"type":"object","description":"A single customer network record.","title":"Network record","x-displayname":"Network record","x-ves-proto-message":"ves.io.schema.infraprotect.Network","properties":{"id":{"type":"string","description":" ID of the network.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Network IDListNetworksResponse","x-displayname":"Network ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"name":{"type":"string","description":" Name of the network.\n\nExample: ` \"DDOS_proof_1\"`","title":"Network name","x-displayname":"Network name","x-ves-example":"DDOS_proof_1"},"prefixes":{"$ref":"#/components/schemas/schemaPrefixListType"},"primary":{"type":"boolean","description":" If true then the network is the primary customer's network and should always be preferred.\n The rules governing:\n * The network is flagged as such during onboarding via the signup object->infraprotect_information\n * Customer network called %customer_name%_local - e.g. defensenet_local\n * The only customer's network (if customer has only one network)","title":"Primary","format":"boolean","x-displayname":"Primary"}}},"infraprotectReport":{"type":"object","description":"A single DDoS report record.","title":"Report record","x-displayname":"Report record","x-ves-proto-message":"ves.io.schema.infraprotect.Report","properties":{"created_at":{"type":"string","description":" RFC3339 string of the creation date.\n\nExample: ` \"2021-01-01T00:00:00Z\"`","title":"Created date","format":"date-time","x-displayname":"Created date","x-ves-example":"2021-01-01T00:00:00Z"},"gos_name":{"type":"string","description":" Name of the report.\n\nExample: ` \"dos-proof-report\"`","title":"Storage name","x-displayname":"Storage name","x-ves-example":"dos-proof-report"},"id":{"type":"string","description":" ID of the report.\n\nExample: ` \"9ba097cf-35e3-4560-9c00-5a1a36b8f85b\"`","title":"Report ID","x-displayname":"Report ID","x-ves-example":"9ba097cf-35e3-4560-9c00-5a1a36b8f85b"},"name":{"type":"string","description":" Name of the report.\n\nExample: ` \"DOS proof report 01/2022\"`","title":"Report name","x-displayname":"Report name","x-ves-example":"DOS proof report 01/2022"},"scheduled":{"type":"boolean","description":" True if the report is scheduled","title":"Scheduled flag","format":"boolean","x-displayname":"Scheduled"},"scheduled_name":{"type":"string","description":" Full name, including the date part.\n Optional, only present if `scheduled` is set to true.\n\nExample: ` \"dos-proof-report-01-01-2022\"`","title":"Scheduled name","x-displayname":"Scheduled name","x-ves-example":"dos-proof-report-01-01-2022"},"type":{"type":"string","description":" Type of the report.\n\nExample: ` \"DoS proof daily report\"`","title":"Report type","x-displayname":"Report type","x-ves-example":"DoS proof daily report"},"version":{"type":"string","description":" Document version assigned by generic object store\n\nExample: ` \"v01-00-00-00\"`","title":"Storage version","x-displayname":"Version","x-ves-example":"v01-00-00-00"}}},"infraprotectSuggestValuesReq":{"type":"object","description":"Request body of SuggestValues request","title":"SuggestValuesReq","x-displayname":"Request for SuggestValues","x-ves-proto-message":"ves.io.schema.infraprotect.SuggestValuesReq","properties":{"field_path":{"type":"string","description":" JSON path of the field for which the suggested values are being requested.\n\nExample: ` \"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"field_path","maxLength":1024,"x-displayname":"Field Path","x-ves-example":"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"match_value":{"type":"string","description":" A substring that must be present in either the value or description of each SuggestedItem in the response.\n\nExample: ` \"some-substring\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"match_value","maxLength":256,"x-displayname":"Match Value","x-ves-example":"some-substring","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"request_body":{"$ref":"#/components/schemas/protobufAny"}}},"infraprotectTransitUsageData":{"type":"object","description":"Transit Usage data contains the transit usage type and the corresponding metric value","title":"Transit Usage Data","x-displayname":"Transit Usage Data","x-ves-proto-message":"ves.io.schema.infraprotect.TransitUsageData","properties":{"data":{"type":"array","description":" List of metric data ","title":"Data","items":{"$ref":"#/components/schemas/infraprotectTransitUsageTypeData"},"x-displayname":"Data"},"type":{"$ref":"#/components/schemas/infraprotectTransitUsageType"},"unit":{"$ref":"#/components/schemas/schemaUnitType"}}},"infraprotectTransitUsageLabel":{"type":"string","description":"Labels in transit usage metrics\n","title":"Transit Usage Label","enum":["POP","DEVICE","INTERFACE","CIRCUIT_ID"],"default":"POP","x-displayname":"Transit Usage Label","x-ves-proto-enum":"ves.io.schema.infraprotect.TransitUsageLabel"},"infraprotectTransitUsageRequest":{"type":"object","description":"Request to get transit usage data","title":"Transit Usage Request","x-displayname":"Transit Usage Request","x-ves-proto-message":"ves.io.schema.infraprotect.TransitUsageRequest","properties":{"end_time":{"type":"string","description":" end time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the end_time will be evaluated to start_time+10m\n           If start_time is not specified, then the end_time will be evaluated to <current time>\n\nExample: ` \"1570197600\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"End time","x-displayname":"End Time","x-ves-example":"1570197600","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"field_selector":{"type":"array","description":" Select fields to be returned in the response.\n One or more fields in {IN_THROUGHPUT_BYTES, IN_THROUGHPUT_PACKETS, OUT_THROUGHPUT_BYTES, OUT_THROUGHPUT_PACKETS} can be specified.\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 8\n  ves.io.schema.rules.repeated.min_items: 1\n  ves.io.schema.rules.repeated.unique: true\n","title":"Field Selector","minItems":1,"maxItems":8,"items":{"$ref":"#/components/schemas/infraprotectTransitUsageType"},"x-displayname":"Field Selector","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"8","ves.io.schema.rules.repeated.min_items":"1","ves.io.schema.rules.repeated.unique":"true"}},"filter":{"type":"string","description":" filter is used to specify the list of matchers\n syntax for filter := {[<matcher>]}\n <matcher> := <label><operator>\"<value>\"\n   <label> := string\n     One or more labels defined in MetricLabel {POP, DEVICE, INTERFACE} can be specified in the filter.\n   <value> := string\n   <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n     =  : equal to\n     != : not equal to\n     =~ : regex match\n     !~ : not regex match\n\n Optional: If not specified, metric will be aggregated based on the group_by labels. \n\nExample: ` \"{POP=\\\"pop-1\\\"}\"`","title":"Label Filter","x-displayname":"Filter","x-ves-example":"{POP=\\\"pop-1\\\"}"},"group_by":{"type":"array","description":" Aggregate data by zero or more labels {POP, DEVICE, INTERFACE}","title":"Group by","items":{"$ref":"#/components/schemas/infraprotectTransitUsageLabel"},"x-displayname":"Group By"},"namespace":{"type":"string","description":"\n\nExample: ` \"system\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"system"},"range":{"type":"string","description":" range decides how far to go back in time to fetch values for each step.\n For example, if the range is 5m, then for step t1, query will be evaluated for t1-5m and for\n t2, query will be evaluated for t2-5m and so on.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Note: For non-timeseries query, i.e., for step=end_time-start_time, range should be set to end_time-start_time\n\n Optional: If not specified, range is set to 5m\n\nExample: ` \"10m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"Range","x-displayname":"Range","x-ves-example":"10m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}},"start_time":{"type":"string","description":"\n start time of metric collection from which data will be considered to build graph.\n Format: unix_timestamp|rfc 3339\n\n Optional: If not specified, then the start_time will be evaluated to end_time-10m\n           If end_time is not specified, then the start_time will be evaluated to <current time>-10m\n\nExample: ` \"1570194000\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"Start time","x-displayname":"Start Time","x-ves-example":"1570194000","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"step":{"type":"string","description":" step is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\n The timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\n Optional: If not specified, then step size is evaluated to <end_time - start_time>\n\nExample: ` \"5m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_step: true\n","title":"Step","x-displayname":"Step","x-ves-example":"5m","x-ves-validation-rules":{"ves.io.schema.rules.string.query_step":"true"}}}},"infraprotectTransitUsageResponse":{"type":"object","description":"Transit usage response data","title":"Transit Usage Response","x-displayname":"Transit Usage Response","x-ves-proto-message":"ves.io.schema.infraprotect.TransitUsageResponse","properties":{"data":{"type":"array","description":" Data contains time-series Transit Usage data","title":"Data","items":{"$ref":"#/components/schemas/infraprotectTransitUsageData"},"x-displayname":"Data"},"step":{"type":"string","description":" Actual step size used in the response. It could be higher than the requested step due to metric rollups and the query duration.\n Format: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days\n\nExample: ` \"30m\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.time_interval: true\n","title":"step","x-displayname":"Step","x-ves-example":"30m","x-ves-validation-rules":{"ves.io.schema.rules.string.time_interval":"true"}}}},"infraprotectTransitUsageType":{"type":"string","description":"List of Transit Usage metric types\n\nx-unit: \"Bps\"\nx-unit: \"pps\"\nx-unit: \"Bps\"\nx-unit: \"pps\"","title":"Transit Usage Type","enum":["IN_THROUGHPUT_BYTES","IN_THROUGHPUT_PACKETS","OUT_THROUGHPUT_BYTES","OUT_THROUGHPUT_PACKETS"],"default":"IN_THROUGHPUT_BYTES","x-displayname":"Transit Usage Type","x-ves-proto-enum":"ves.io.schema.infraprotect.TransitUsageType"},"infraprotectTransitUsageTypeData":{"type":"object","description":"Transit Usage Type Data contains key/value pair that uniquely identifies the group_by labels specified in the request.","title":"Transit Usage Type Data","x-displayname":"Transit Usage Type Data","x-ves-proto-message":"ves.io.schema.infraprotect.TransitUsageTypeData","properties":{"key":{"type":"object","description":" Key contains the name/value pair.\n \"name\" is the label name defined in \"TransitUsageLabel\"","title":"Key","x-displayname":"Key"},"value":{"type":"array","description":" List of metric values.","title":"Value","items":{"$ref":"#/components/schemas/schemaMetricValue"},"x-displayname":"Value"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"schemaIpAddressType":{"type":"object","description":"IP Address used to specify an IPv4 or IPv6 address","title":"IP Address","x-displayname":"IP Address","x-ves-displayorder":"3","x-ves-oneof-field-ver":"[\"ipv4\",\"ipv6\"]","x-ves-proto-message":"ves.io.schema.IpAddressType","properties":{"ipv4":{"$ref":"#/components/schemas/schemaIpv4AddressType"},"ipv6":{"$ref":"#/components/schemas/schemaIpv6AddressType"}}},"schemaIpv4AddressType":{"type":"object","description":"IPv4 Address in dot-decimal notation","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-proto-message":"ves.io.schema.Ipv4AddressType","properties":{"addr":{"type":"string","description":" IPv4 Address in string form with dot-decimal notation\n\nExample: ` \"192.168.1.1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv4: true\n","title":"IPv4 Address","x-displayname":"IPv4 Address","x-ves-example":"192.168.1.1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv4":"true"}}}},"schemaIpv6AddressType":{"type":"object","description":"IPv6 Address specified as hexadecimal numbers separated by ':'","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-proto-message":"ves.io.schema.Ipv6AddressType","properties":{"addr":{"type":"string","description":" IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ':'\n The address can be compacted by suppressing zeros\n e.g. '2001:db8:0:0:0:0:2:1' becomes '2001:db8::2:1' or '2001:db8:0:0:0:2:0:0' becomes '2001:db8::2::'\n\nExample: ` \"2001:db8:0:0:0:0:2:1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.ipv6: true\n","title":"IPv6 Address","x-displayname":"IPv6 Address","x-ves-example":"2001:db8:0:0:0:0:2:1","x-ves-validation-rules":{"ves.io.schema.rules.string.ipv6":"true"}}}},"schemaMetricValue":{"type":"object","description":"Metric data contains timestamp and the value.","title":"Metric Value","x-displayname":"Metric Value","x-ves-proto-message":"ves.io.schema.MetricValue","properties":{"timestamp":{"type":"number","description":" timestamp\n\nExample: ` \"1570007981\"`","title":"Timestamp","format":"double","x-displayname":"Timestamp","x-ves-example":"1570007981"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"},"value":{"type":"string","description":"\n\nExample: ` \"15\"`","title":"Value","x-displayname":"Value","x-ves-example":"15"}}},"schemaPrefixListType":{"type":"object","description":"List of IP Address prefixes. Prefix must contain both prefix and prefix-length\nThe list can contain mix of both IPv4 and IPv6 prefixes","title":"IP Prefix List","x-displayname":"IP Prefix List","x-ves-proto-message":"ves.io.schema.PrefixListType","properties":{"prefix":{"type":"array","description":" IP Address prefix in string format. String must contain both prefix and prefix-length\n\nExample: ` \"[192.168.1.0/24, 192.168.2.0/24]\"\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.items.string.ipv4_prefix: true\n  ves.io.schema.rules.repeated.max_items: 256\n","title":"Prefix","maxItems":256,"items":{"type":"string"},"x-displayname":"Prefix","x-ves-example":"[192.168.1.0/24, 192.168.2.0/24]\"","x-ves-validation-rules":{"ves.io.schema.rules.repeated.items.string.ipv4_prefix":"true","ves.io.schema.rules.repeated.max_items":"256"}}}},"schemaTrendSentiment":{"type":"string","description":"trend sentiment\n\nIndicates trend sentiment is positive\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE","x-displayname":"Trend Sentiment","x-ves-proto-enum":"ves.io.schema.TrendSentiment"},"schemaTrendValue":{"type":"object","description":"Trend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","x-displayname":"Trend Value","x-ves-proto-message":"ves.io.schema.TrendValue","properties":{"description":{"type":"string","description":" description of the method used to calculate trend.\n\nExample: ` \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"`","title":"Description","x-displayname":"Description","x-ves-example":"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval"},"previous_value":{"type":"string","description":"\n\nExample: ` \"200.00\"`","title":"Previous Value","x-displayname":"Previous Value","x-ves-example":"200.00"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"\n\nExample: ` \"-15\"`","title":"Value","x-displayname":"Value","x-ves-example":"-15"}}},"schemaUnitType":{"type":"string","description":"UnitType is enumeration of units for scalar fields","title":"UnitType","enum":["UNIT_MILLISECONDS","UNIT_SECONDS","UNIT_MINUTES","UNIT_HOURS","UNIT_DAYS","UNIT_BYTES","UNIT_KBYTES","UNIT_MBYTES","UNIT_GBYTES","UNIT_TBYTES","UNIT_KIBIBYTES","UNIT_MIBIBYTES","UNIT_GIBIBYTES","UNIT_TEBIBYTES","UNIT_BITS_PER_SECOND","UNIT_BYTES_PER_SECOND","UNIT_KBITS_PER_SECOND","UNIT_KBYTES_PER_SECOND","UNIT_MBITS_PER_SECOND","UNIT_MBYTES_PER_SECOND","UNIT_CONNECTIONS_PER_SECOND","UNIT_ERRORS_PER_SECOND","UNIT_PACKETS_PER_SECOND","UNIT_REQUESTS_PER_SECOND","UNIT_PACKETS","UNIT_PERCENTAGE","UNIT_COUNT"],"default":"UNIT_MILLISECONDS","x-displayname":"Unit","x-ves-proto-enum":"ves.io.schema.UnitType"},"schemainfraprotectSuggestValuesResp":{"type":"object","description":"Response body of SuggestValues request","title":"SuggestValuesResp","x-displayname":"Response for SuggestValues","x-ves-proto-message":"ves.io.schema.infraprotect.SuggestValuesResp","properties":{"items":{"type":"array","description":" List of suggested items.","title":"item_lists","items":{"$ref":"#/components/schemas/schemainfraprotectSuggestedItem"},"x-displayname":"Suggested Items"}}},"schemainfraprotectSuggestedItem":{"type":"object","description":"A tuple with a suggested value and it's description.","title":"SuggestedItem","x-displayname":"Suggested Item","x-ves-oneof-field-value_choice":"[\"ref_value\",\"str_value\"]","x-ves-proto-message":"ves.io.schema.infraprotect.SuggestedItem","properties":{"description":{"type":"string","description":" Optional description for the suggested value.","title":"description","x-displayname":"Description"},"ref_value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"str_value":{"type":"string","description":"Exclusive with [ref_value]\n","title":"str_value","x-displayname":"String"},"value":{"type":"string","description":" Suggested value for the field.\n Should use value_choice.str_value instead.","title":"value","x-displayname":"Value"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}}}}}