@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.log","description":"Two types of logs are supported, viz, access logs and audit logs.\n  * Access logs are sampled records of API calls made to a virtual host. It contains\n    both the request and the response data with more context like application type,\n    user, request path, method, request body, response code, source,\n    destination, etc.,\n  * Audit logs provides audit of all configuration changes made in the system using\n    public APIs provided by Volterra. It contains both the request and response body\n    with additional context necessary for post-mortem analysis such as user, request path,\n    method, request body, response code, source, destination service, etc.,\nBoth the access logs and audit logs are used to find \"who did what and when and what was the result?\"\nwho - answered by user/user-agent in the log.\nwhat - answered by request url/method/body in the log.\nwhen - answered by timestamp in the log.\nresult - answered by response code in the log.","version":""},"paths":{"/api/data/namespaces/{namespace}/access_logs":{"post":{"summary":"Access Log Query V2","description":"Request to get access logs that matches the criteria in request for a given namespace.\nTypically, virtual host is specified as match condition in the request to get all access logs\nfor a virtual host. By default, the access logs in the response are sorted in the reverse chronological order.","operationId":"ves.io.schema.log.CustomAPI.AccessLogQueryV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch access logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logAccessLogRequestV2"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-accesslogqueryv2"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AccessLogQueryV2"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/access_logs/aggregation":{"post":{"summary":"Access Log Aggregation Query","description":"Request to get summary/analytics data for the access logs that matches the query in request for a given namespace.\nTypically, virtual host is specified as match condition in the request to get the aggregaation data\nfor a virtual host.","operationId":"ves.io.schema.log.CustomAPI.AccessLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logAccessLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-accesslogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AccessLogAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/access_logs/scroll":{"get":{"summary":"Access Log Scroll Query","description":"The response for access log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\naccess log query in multiple batches. EOF is indicated by empty scroll_id in the response.","operationId":"ves.io.schema.log.CustomAPI.AccessLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-accesslogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AccessLogScrollQuery"},"post":{"summary":"Access Log Scroll Query","description":"The response for access log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\naccess log query in multiple batches. EOF is indicated by empty scroll_id in the response.","operationId":"ves.io.schema.log.CustomAPI.AccessLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-accesslogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AccessLogScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/audit_logs":{"post":{"summary":"Audit Log Query V2","description":"Request to get audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.AuditLogQueryV2","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch audit logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logAuditLogRequestV2"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-auditlogqueryv2"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AuditLogQueryV2"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/audit_logs/aggregation":{"post":{"summary":"Audit Log Aggregation Query","description":"Request to get summary/analytics data for the audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.AuditLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logAuditLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-auditlogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AuditLogAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/audit_logs/scroll":{"get":{"summary":"Audit Log Scroll Query","description":"The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.AuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-auditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AuditLogScrollQuery"},"post":{"summary":"Audit Log Scroll Query","description":"The response for audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.AuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-auditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.AuditLogScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/firewall_logs":{"post":{"summary":"Firewall Logs Query","description":"Request to get access logs and network logs with policy hits.\nBy default, the firewall logs in the response are sorted in the reverse chronological order.","operationId":"ves.io.schema.log.CustomAPI.FirewallLogQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch Firewall logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logFirewallLogRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-firewalllogquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.FirewallLogQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/firewall_logs/aggregation":{"post":{"summary":"Firewall Logs Aggregation Query","description":"Request to get summary/analytics data for the firewall logs that matches the query in request for a given namespace.","operationId":"ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logFirewallLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-firewalllogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.FirewallLogAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/firewall_logs/scroll":{"get":{"summary":"Firewall Logs Scroll Query","description":"The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.","operationId":"ves.io.schema.log.CustomAPI.FirewallLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-firewalllogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.FirewallLogScrollQuery"},"post":{"summary":"Firewall Logs Scroll Query","description":"The response for firewall log query contain no more than 500 records.\nScroll request is used scroll through more than 500 records or all records that matched the criteria in the\nfirewall log query in multiple batches. EOF is indicated by empty scroll_id in the response.","operationId":"ves.io.schema.log.CustomAPI.FirewallLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-firewalllogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.FirewallLogScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/k8s_audit_logs/scroll":{"get":{"summary":"K8s Audit Log Scroll Query","description":"The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-k8sauditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery"},"post":{"summary":"K8s Audit Log Scroll Query","description":"The response for K8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8sauditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SAuditLogScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/k8s_events/scroll":{"get":{"summary":"K8s Events Scroll Query","description":"The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.K8SEventsScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-k8seventsscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SEventsScrollQuery"},"post":{"summary":"K8s Events Scroll Query","description":"The response for K8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.K8SEventsScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8seventsscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SEventsScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/platform_events":{"post":{"summary":"Platform event Query","description":"Request to get platform event that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for platform events across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.PlatformEventQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch audit logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logPlatformEventRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-platformeventquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.PlatformEventQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/platform_events/aggregation":{"post":{"summary":"Platform event Aggregation Query","description":"Request to get summary/analytics data for the audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for platform event across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logPlatformEventAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-platformeventaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.PlatformEventAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/platform_events/scroll":{"get":{"summary":"Platform event Scroll Query","description":"The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.PlatformEventScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-platformeventscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.PlatformEventScrollQuery"},"post":{"summary":"Platform event Scroll Query","description":"The response for platform event query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.PlatformEventScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-platformeventscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.PlatformEventScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/site/{site}/external_connector/{external_connector}/logs":{"post":{"summary":"External connector log query","description":"Request to get external connector logs that matches the criteria in request for a given namespace.\nThe logs are per site per external connector is specified as match condition in the request to get the logs for a external connector.","operationId":"ves.io.schema.log.CustomAPI.ExternalConnectorLogQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"site\n\nx-example: \"ce-1\"\nSite where the K8s Cluster is running","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}},{"name":"external_connector","description":"external connector\n\nx-example: \"connector-1\"\nExternal connector for which logs has to be fetched","in":"path","required":true,"x-displayname":"External Connector","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logExternalConnectorRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-externalconnectorlogquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.ExternalConnectorLogQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs":{"post":{"summary":"K8s Audit Log Query","description":"Request to get Physical K8s audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces in a K8s Cluster.","operationId":"ves.io.schema.log.CustomAPI.K8SAuditLogQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch K8s audit logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"site\n\nx-example: \"ce-1\"\nSite where the K8s Cluster is running","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logK8SAuditLogRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8sauditlogquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SAuditLogQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/site/{site}/k8s_audit_logs/aggregation":{"post":{"summary":"K8s Audit Log Aggregation Query","description":"Request to get summary/analytics data for the K8s audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces in a K8s Cluster.","operationId":"ves.io.schema.log.CustomAPI.K8SAuditLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"site\n\nx-example: \"ce-1\"\nSite where the K8s Cluster is running","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logK8SAuditLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8sauditlogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SAuditLogAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/site/{site}/k8s_events":{"post":{"summary":"K8s Events Query","description":"Request to get physical K8s events that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nK8s events in the namespace. User with access to the `system` namespace may query for K8s events across\nall namespaces in a K8s Cluster.","operationId":"ves.io.schema.log.CustomAPI.K8SEventsQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch K8s events for the given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"site\n\nx-example: \"ce-1\"\nSite where the K8s Cluster is running","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logK8SEventsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8seventsquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SEventsQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/site/{site}/k8s_events/aggregation":{"post":{"summary":"K8s Events Aggregation Query","description":"Request to get summary/analytics data for the K8s events that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for K8s events across all namespaces in a K8s Cluster.","operationId":"ves.io.schema.log.CustomAPI.K8SEventsAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"site","description":"site\n\nx-example: \"ce-1\"\nSite where the K8s Cluster is running","in":"path","required":true,"x-displayname":"Site","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logK8SEventsAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-k8seventsaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.K8SEventsAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_audit_logs":{"post":{"summary":"vK8s Audit Log Query","description":"Request to get Virtual K8s audit logs that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nCRUD operations performed in the namespace. User with access to the `system` namespace\nmay query for audit logs across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.VK8SAuditLogQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch vK8s audit logs for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logVK8SAuditLogRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8sauditlogquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SAuditLogQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_audit_logs/aggregation":{"post":{"summary":"vK8s Audit Log Aggregation Query","description":"Request to get summary/analytics data for the vK8s audit logs that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for audit logs across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logVK8SAuditLogAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8sauditlogaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SAuditLogAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_audit_logs/scroll":{"get":{"summary":"vK8s Audit Log Scroll Query","description":"The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-vk8sauditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery"},"post":{"summary":"vK8s Audit Log Scroll Query","description":"The response for vK8s audit log query contain no more than 500 messages.\nOne can use scroll request to scroll through more than 500 messages or all messages\nin multiple batches. empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8sauditlogscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SAuditLogScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_events":{"post":{"summary":"vK8s Events Query","description":"Request to get Virtual K8s events that matches the criteria in request for a given namespace.\nIf no match conditions are specified in the request, then the response contains all\nvK8s events in the namespace. User with access to the `system` namespace may query for vK8s across\nall namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.VK8SEventsQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch vK8s events for the given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logVK8SEventsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8seventsquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SEventsQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_events/aggregation":{"post":{"summary":"vK8s Events Aggregation Query","description":"Request to get summary/analytics data for the vK8s events that matches the criteria in request for a given namespace.\nUser with access to the `system` namespace may query aggregated data for vK8s events across all namespaces for a given tenant.","operationId":"ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogAggregationResponse"}}}},"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\"\nget aggregation data for a given namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logVK8SEventsAggregationRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8seventsaggregationquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SEventsAggregationQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/data/namespaces/{namespace}/vk8s_events/scroll":{"get":{"summary":"vK8s Events Scroll Query","description":"The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"scroll_id","description":"x-example: \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"\nLong Base-64 encoded string which can be used to retrieve next batch of log messages.","in":"query","required":false,"x-displayname":"Scroll 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-log-customapi-vk8seventsscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery"},"post":{"summary":"vK8s Events Scroll Query","description":"The response for vK8s events query contain no more than 500 events.\nOne can use scroll request to scroll through more than 500 events or all events\nin multiple batches. Empty scroll_id in the response indicates no more messages to fetch (EOF).","operationId":"ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogResponse"}}}},"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\"\nfetch the log messages scoped by namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/logLogScrollRequest"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-log-customapi-vk8seventsscrollquery"},"x-ves-proto-rpc":"ves.io.schema.log.CustomAPI.VK8SEventsScrollQuery"},"x-displayname":"Logs","x-ves-proto-service":"ves.io.schema.log.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Logs","x-ves-proto-package":"ves.io.schema.log","components":{"requestBodies":{"logLogScrollRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/logLogScrollRequest"}}},"required":true}},"schemas":{"access_logAvgAggregation":{"type":"object","description":"x-displayName: \"Avg aggregation\"\nGet the average value of the numeric values extracted from the field in the access log.","title":"Average aggregation","properties":{"field":{"$ref":"#/components/schemas/access_logNumKeyField"}}},"access_logFieldSubAggregation":{"type":"object","description":"x-displayName: \"Field SubAggregation\"\nAggregate access logs in each aggregation field bucket based on one of the sub aggregation types","title":"Field SubAggregation","properties":{"avg_aggregation":{"$ref":"#/components/schemas/access_logAvgAggregation"},"max_aggregation":{"$ref":"#/components/schemas/access_logMaxAggregation"},"min_aggregation":{"$ref":"#/components/schemas/access_logMinAggregation"}}},"access_logMaxAggregation":{"type":"object","description":"x-displayName: \"Max aggregation\"\nGet the maximum value among the numeric values extracted from the field in the access log.","title":"Max aggregation","properties":{"field":{"$ref":"#/components/schemas/access_logNumKeyField"}}},"access_logMinAggregation":{"type":"object","description":"x-displayName: \"Min aggregation\"\nGet the minimum value among the numeric values extracted from the field in the access log.","title":"Min aggregation","properties":{"field":{"$ref":"#/components/schemas/access_logNumKeyField"}}},"access_logMultiFieldAggregation":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation\"\nAggregate security events based on the multiple fields in the security event.","title":"Multi-Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/access_logMultiKeyField"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each multi-field aggregation bucket.","title":"sub aggregation"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"10\"\n\nNumber of top field values to be returned in the response.","title":"topk","format":"int64"}}},"access_logMultiKeyField":{"type":"string","description":"x-displayName: \"Multi-Key Field\"\nSecurity events can be aggregated based on these multiple key fields\n\n - VH_NAME_NAMESPACE: x-displayName: \"VH Name, Namespace\"\nAggregated by (KeyField.VH_NAME, KeyField.NAMESPACE)\n - API_ENDPOINT_METHOD: x-displayName: \"api_endpoint, method\"\nAggregated by (KeyField.API_ENDPOINT, KeyField.METHOD)\n - API_ENDPOINT_METHOD_RSP_CODE_CLASS: x-displayName: \"api_endpoint, method, rsp_code_class\"\nAggregated by (KeyField.API_ENDPOINT, KeyField.METHOD, KeyField.rsp_code_class)","title":"Multi-Key Field","enum":["VH_NAME_NAMESPACE","API_ENDPOINT_METHOD","API_ENDPOINT_METHOD_RSP_CODE_CLASS"],"default":"VH_NAME_NAMESPACE"},"access_logNumKeyField":{"type":"string","description":"x-displayName: \"Num-Key Field\"\nAccess log can be aggregated based on these numeric fields.\n\n - DURATION_WITH_DATA_TX_DELAY: x-displayName: \"DURATION WITH DATA TX DELAY\"\n - TIMESTAMP: x-displayName: \"TIMESTAMP\"","title":"Numeric-Key Field","enum":["DURATION_WITH_DATA_TX_DELAY","TIMESTAMP"],"default":"DURATION_WITH_DATA_TX_DELAY"},"logAccessLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for access logs","title":"AccessLogAggregationRequest","x-displayname":"Access Log Aggregation Request","x-ves-proto-message":"ves.io.schema.log.AccessLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch access logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n   One or more of following fields in access log may be specified in the query.\n     app_type - application type\n     vh_name - name of the virtual host\n     src_site - source site\n     src - source service\n     src_instance - source instance\n     dst_site - destination site\n     dst - destination service\n     dst_instance - destination instance\n     method - request method\n     req_path - request path\n     rsp_code - response code\n     browser_type - browser type\n     city - name of the city\n     country - country code\n     device_type - device type\n <value> := string\n <operator> := [\"=\"|\"!=\"]\n   = : equal to\n   != : not equal to\n When more than one matcher is specified in the query, then access logs matching ALL the matchers will be considered for aggregation.\n Example: query={src=\"service1\", dst=\"service2\"} will consider all access logs with source service \"service1\" and the destination service \"service2\"\n\n Optional: If not specified, all the access logs matching the given tenant, namespace will be considered for aggregation\n\nExample: ` \"{vh_name=\\\"productpage\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{vh_name=\\\"productpage\\\"}"},"start_time":{"type":"string","description":" fetch access logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logAccessLogRequestV2":{"type":"object","description":"Request to fetch access logs.","title":"AccessLogRequestV2","x-displayname":"Access Log Request V2","x-ves-proto-message":"ves.io.schema.log.AccessLogRequestV2","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch access logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"0\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"0"},"namespace":{"type":"string","description":" fetch access logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n   One or more of following fields in access log may be specified in the query.\n     app_type - application type\n     vh_name - name of the virtual host\n     src_site - source site\n     src - source service\n     src_instance - source instance\n     dst_site - destination site\n     dst - destination service\n     dst_instance - destination instance\n     method - request method\n     req_path - request path\n     rsp_code - response code\n     browser_type - browser type\n     city - name of the city\n     country - country code\n     device_type - device type\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then access logs matching ALL the matchers will be returned in the response.\n Example: query={src=\"service1\", dst=\"service2\"} will return all access logs with source service \"service1\" and the destination service \"service2\"\n          query={vh_name=\"vh1\", rsp_code=~\"4.*\"} will return all access logs for virtual-host \"vh1\" with response code 4xx\n\n Optional: If not specified, all the access logs matching the given tenant, namespace will be returned in the response\n\nExample: ` \"{vh_name=\\\"productpage\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{vh_name=\\\"productpage\\\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch access logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logAuditLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for audit logs","title":"AuditLogAggregationRequest","x-displayname":"Audit Log Aggregation Request","x-ves-proto-message":"ves.io.schema.log.AuditLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user - user name\n   src_site - source site\n   src - source service\n   src_instance - source instance\n   dst_site - destination site\n   dst - destination service\n   dst_instance - destination instance\n   method - request method\n   req_path - request URL\n   rsp_code - response code\n <value> := string\n <operator> := [\"=\"|\"!=\"]\n   = : equal to\n   != : not equal to\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation\n\nExample: ` \"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logAuditLogRequestV2":{"type":"object","description":"Request to fetch audit logs","title":"AuditLogRequestV2","x-displayname":"Audit Log Request V2","x-ves-proto-message":"ves.io.schema.log.AuditLogRequestV2","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch audit logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user - user name\n   src_site - source site\n   src - source service\n   src_instance - source instance\n   dst_site - destination site\n   dst - destination service\n   dst_instance - destination instance\n   method - request method\n   req_path - request URL\n   rsp_code - response code\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={req_path=\"/public/namespaces/system/registrations\"} will return all audit logs with req_path equals /public/namespaces/system/registrations\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace are returned\n\nExample: ` \"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logAvgAggregationData":{"type":"object","description":"x-displayName: \"Avg Aggregation Data\"\nAverage Aggregation data","title":"AvgAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the average value of field","title":"value","format":"double"}}},"logCardinalityAggregationData":{"type":"object","description":"x-displayName: \"Cardinality Aggregation Data\"\nApproximate count of distinct values of the log field specified in the request.","title":"CardinalityAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of distinct values of a log field","title":"count","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregationBucket":{"type":"object","description":"x-displayName: \"Date Aggregation Bucket\"\nDate histogram bucket containing the timestamp and the number of logs in that bucket.","title":"DateAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the date bucket","title":"sub aggregation"},"time":{"type":"string","description":"x-displayName: \"Time\"\nx-example: 1578710280000\n\nunix timestamp","title":"time","format":"uint64"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logDateAggregationData":{"type":"object","description":"x-displayName: \"Date Aggregation Data\"\nDate aggregation data","title":"DateAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing timestamp and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logDateAggregationBucket"}},"step":{"type":"string","description":"x-displayName: \"Step\"\nx-example: \"30m\"\nActual step size in the response. It could be higher than the requested step depending on the query duration and/or the log rollups.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logDateSubAggregationData":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\n\nDate subaggregation data","title":"DateSubAggregationData","properties":{"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"}}},"logExternalConnectorRequest":{"type":"object","description":"Request to get logs for a external connector","title":"External Connector Request","x-displayname":"External Connector Request","x-ves-proto-message":"ves.io.schema.log.ExternalConnectorRequest","properties":{"end_time":{"type":"string","description":" fetch external connector logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"external_connector":{"type":"string","description":" External connector for which logs has to be fetched\n\nExample: ` \"connector-1\"`","title":"external connector","x-displayname":"External Connector","x-ves-example":"connector-1"},"label_filter":{"type":"array","description":" List of label filter expressions of the form \"label key\" QueryOp \"value\".\n Response will only contain data that matches all the conditions specified in the label_filter.\n For external connector logs, user can specify LABEL_EXTERNAL_CONNECTOR_IP & LABEL_EXTERNAL_CONNECTOR_NODE in the label_filter\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.repeated.max_items: 5\n","title":"Label Filter","maxItems":5,"items":{"$ref":"#/components/schemas/logLabelFilter"},"x-displayname":"Label Filter","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.repeated.max_items":"5"}},"limit":{"type":"integer","description":" Limits the number of results\n\nExample: ` \"5\"`\n\nValidation Rules:\n  ves.io.schema.rules.uint32.gte: 0\n  ves.io.schema.rules.uint32.lte: 500\n","title":"Limit","format":"int64","x-displayname":"Limit","x-ves-example":"5","x-ves-validation-rules":{"ves.io.schema.rules.uint32.gte":"0","ves.io.schema.rules.uint32.lte":"500"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"site":{"type":"string","description":" Site where the K8s Cluster is running\n\nExample: ` \"ce-1\"`","title":"site","x-displayname":"Site","x-ves-example":"ce-1"},"start_time":{"type":"string","description":" fetch external connector logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Aggregation Bucket\"\nField aggregation bucket containing field value and the number of logs.","title":"FieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nx-example: \"US\"","title":"key"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the field aggregation bucket","title":"sub aggregation"},"trend_value":{"$ref":"#/components/schemas/schemaTrendValue"}}},"logFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Aggregation Data\"\nField Aggregation data","title":"FieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldAggregationBucket"}}}},"logFieldSubAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"}}},"logFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Field SubAggregation\"\nField subaggregation data","title":"FieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubAggregationBucket"}},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logFieldSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FieldSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"}}},"logFieldSubFieldAggregationData":{"type":"object","description":"x-displayName: \"Field Sub Field Aggregation Data\"\nField Aggregation data as Field Sub-aggregation","title":"FieldSubFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFieldSubFieldAggregationBucket"}}}},"logFilterAggregationData":{"type":"object","description":"x-displayName: \"Filter Aggregation Data\"\nFilter Aggregation Data","title":"FilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logFilterSubAggregationData":{"type":"object","description":"x-displayName: \"FilterSubAggregation\"\nFilter subaggregation data","title":"FilterSubAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field value and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logFilterSubFieldAggregationBucket"}}}},"logFilterSubFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Filter Sub Field Aggregation Bucket\"\nField sub aggregation bucket containing field values and the number of logs.","title":"FilterSubFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"key":{"type":"string","description":"x-displayName: \"Key\"\nKey contain the name/value pair that identifies the unique key fields\nx-example: \"HIT, MISS, REVALIDATED\"","title":"keys"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the filter aggregation","title":"sub aggregation"}}},"logFirewallLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for Firewall logs","title":"FirewallLogAggregationRequest","x-displayname":"Firewall Log Aggregation Request","x-ves-proto-message":"ves.io.schema.log.FirewallLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch Firewall logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n   One or more of following fields in Firewall log may be specified in the query.\n     site - Name of the site\n     src_ip - Source IP Address\n     dst_ip - Destination IP Address\n     policy_hits.policy - Policy Name\n     policy_hits.policy_rule - Policy Rule Name\n     policy_hits.result - allow|deny|default_deny\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\n Optional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response\n\nExample: ` \"{site=\\\"site-1\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{site=\\\"site-1\\\"}"},"start_time":{"type":"string","description":" fetch Firewall logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logFirewallLogRequest":{"type":"object","description":"Request to fetch Firewall logs.","title":"FirewallLogRequest","x-displayname":"Firewall Log Request","x-ves-proto-message":"ves.io.schema.log.FirewallLogRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch Firewall logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"0\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"0"},"namespace":{"type":"string","description":" fetch Firewall logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n   One or more of following fields in Firewall log may be specified in the query.\n     site - Name of the site\n     src_ip - Source IP Address\n     dst_ip - Destination IP Address\n     policy_hits.policy - Policy Name\n     policy_hits.policy_rule - Policy Rule Name\n     policy_hits.result - allow|deny|default_deny\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then Firewall logs matching ALL the matchers will be returned in the response.\n\n Optional: If not specified, all the Firewall logs matching the given tenant, namespace will be returned in the response\n\nExample: ` \"{site=\\\"site-1\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{site=\\\"site-1\\\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch Firewall logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logK8SAuditLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for K8s audit logs","title":"K8SAuditLogAggregationRequest","x-displayname":"K8s Audit Log Aggregation Request","x-ves-proto-message":"ves.io.schema.log.K8SAuditLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user.username - user name\n   sourceIPs - source ip\n   verb - method\n   objectRef.resource - K8s resource\n   requestURI - request URI\n <value> := string\n <operator> := [\"=\"|\"!=\"]\n   = : equal to\n   != : not equal to\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={objectRef.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation\n\nExample: ` \"query={objectRef.resource=\"deployments\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={objectRef.resource=\"deployments\"}"},"site":{"type":"string","description":" Site where the K8s Cluster is running\n\nExample: ` \"ce-1\"`","title":"site","x-displayname":"Site","x-ves-example":"ce-1"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logK8SAuditLogRequest":{"type":"object","description":"Request to fetch K8s audit logs","title":"K8SAuditLogRequest","x-displayname":"K8s Audit Log Request","x-ves-proto-message":"ves.io.schema.log.K8SAuditLogRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch K8s audit logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user.username - user name\n   sourceIPs - source ip\n   verb - method\n   objectRef.resource - K8s resource\n   requestURI - request URI\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={objectRef.resource=\"deployments\"} will return all K8s audit logs for all deployment objects in the given namespace\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace are returned\n\nExample: ` \"query={objectRef.resource=\"deployments\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={objectRef.resource=\"deployments\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"site":{"type":"string","description":" Site where the K8s Cluster is running\n\nExample: ` \"ce-1\"`","title":"site","x-displayname":"Site","x-ves-example":"ce-1"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logK8SEventsAggregationRequest":{"type":"object","description":"Request to get only aggregation data for K8s events in a Cluster","title":"K8s Events Aggregation Request","x-displayname":"K8s Events Aggregation Request","x-ves-proto-message":"ves.io.schema.log.K8SEventsAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch vK8s events whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in the event may be specified in the query.\n   involvedObject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\n   involvedObject.name - Name of the object\n   type - Type of event such as Warning or Normal\n   reason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\n   source.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\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, all the K8s events for the given tenant and namespace are returned\n\nExample: ` \"query={involvedObject.kind=\"Pod\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={involvedObject.kind=\"Pod\"}"},"site":{"type":"string","description":" Site where the K8s Cluster is running\n\nExample: ` \"ce-1\"`","title":"site","x-displayname":"Site","x-ves-example":"ce-1"},"start_time":{"type":"string","description":" fetch vK8s events whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logK8SEventsRequest":{"type":"object","description":"Request to fetch physical K8s events","title":"K8s Events Request","x-displayname":"K8s Events Request","x-ves-proto-message":"ves.io.schema.log.K8SEventsRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch vK8s events whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of K8s events returned in the response\n Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch K8s events for the given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in the event may be specified in the query.\n   involvedObject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\n   involvedObject.name - Name of the object\n   type - Type of event such as Warning or Normal\n   reason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\n   source.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n   site - Name of the site\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, all the K8s events for the given tenant and namespace are returned\n\nExample: ` \"query={involvedObject.kind=\"Pod\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={involvedObject.kind=\"Pod\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of events (or all events) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of events until there are no more events left to return. The number of events in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"site":{"type":"string","description":" Site where the K8s Cluster is running\n\nExample: ` \"ce-1\"`","title":"site","x-displayname":"Site","x-ves-example":"ce-1"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch vK8s events whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logLabelFilter":{"type":"object","description":"Label Filter is used to filter th that match the logs specified label key/value\nand the operator.","title":"Label Filter","x-displayname":"Label Filter","x-ves-proto-message":"ves.io.schema.log.LabelFilter","properties":{"label":{"$ref":"#/components/schemas/schemalogLabel"},"op":{"$ref":"#/components/schemas/schemaMetricLabelOp"},"value":{"type":"string","description":" Value of the label\n\nExample: ` \"ce01\"`\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":"Value","maxLength":256,"x-displayname":"Value","x-ves-example":"ce01","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_len":"256"}}}},"logLogAggregationData":{"type":"object","description":"x-displayName: \"Log Aggregation\"\nLog aggregation response data","title":"LogAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"date_aggregation":{"$ref":"#/components/schemas/logDateAggregationData"},"field_aggregation":{"$ref":"#/components/schemas/logFieldAggregationData"},"filter_aggregation":{"$ref":"#/components/schemas/logFilterAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"multi_field_aggregation":{"$ref":"#/components/schemas/logMultiFieldAggregationData"},"multi_filter_aggregation":{"$ref":"#/components/schemas/logMultiFilterAggregationData"}}},"logLogAggregationResponse":{"type":"object","description":"Response message for AuditLogAggregationRequest/AccessLogAggregationRequest","title":"LogAggregationResponse","x-displayname":"Log Aggregation Response","x-ves-proto-message":"ves.io.schema.log.LogAggregationResponse","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregation data is key'ed with the aggregation name specified in the request.","title":"aggregations","x-displayname":"Aggregations"},"total_hits":{"type":"string","description":" total number of log messages that matched the query.\n\nExample: ` \"0\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"0"}}},"logLogResponse":{"type":"object","description":"Response message for AuditLogRequest/AccessLogRequest/LogScrollRequest","title":"LogResponse","x-displayname":"Log Response","x-ves-proto-message":"ves.io.schema.log.LogResponse","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregation data is key'ed with the aggregation name specified in the request.","title":"aggregations","x-displayname":"Aggregations"},"logs":{"type":"array","description":" list of log messages that matched the query. Not all log messages that matched the query are returned in the response.\n\nExample: ` \"value\"`","title":"logs","items":{"type":"string"},"x-displayname":"Logs","x-ves-example":"value"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of log messages using the scroll request.\n Empty scroll_id indicates no more messages to scroll (EOF).\n Note: scroll_id is valid only for 2 minutes. i.e., If one intend to retrieve next batch of the result, then the\n       scroll request should be sent within 2 minutes upon receiving the LogResponse.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="},"total_hits":{"type":"string","description":" total number of log messages that matched the query.\n\nExample: ` \"0\"`","title":"total hits","format":"uint64","x-displayname":"Total Hits","x-ves-example":"0"}}},"logLogScrollRequest":{"type":"object","description":"Scroll request is used to fetch large number of log messages in multiple batches with each LogResponse\ncontaining no more than 500 (max value for limit in the request) log messages. To scroll through more than 500 or\nall log messages, one can use the LogScrollRequest. Use the scroll_id returned in the LogResponse to fetch the next\nbatch of log messages and one can continue this process till the scroll_id returned in the LogResponse is \"\" which\nindicates no more log messages to scroll.","title":"LogScrollRequest","x-displayname":"Log Scroll Request","x-ves-proto-message":"ves.io.schema.log.LogScrollRequest","properties":{"namespace":{"type":"string","description":" fetch the log messages scoped by namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"scroll_id":{"type":"string","description":" Long Base-64 encoded string which can be used to retrieve next batch of log messages.\n\nExample: ` \"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ==\"`","title":"scroll id","x-displayname":"Scroll ID","x-ves-example":"Vm9sdGVycmEgRWRnZSBQbGF0Zm9ybQ=="}}},"logMaxAggregationData":{"type":"object","description":"x-displayName: \"Max Aggregation Data\"\nMax Aggregation data","title":"MaxAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the maximum value of field","title":"value","format":"double"}}},"logMetricsAggregationData":{"type":"object","description":"x-displayName: \"Metrics Aggregation\"\nMetrics aggregation data","title":"MetricsAggregationData","properties":{"percentile":{"$ref":"#/components/schemas/logPercentileAggregationData"}}},"logMinAggregationData":{"type":"object","description":"x-displayName: \"Min Aggregation Data\"\nMin Aggregation data","title":"MinAggregationData","properties":{"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the minimum value of field","title":"value","format":"double"}}},"logMultiFieldAggregationBucket":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Bucket\"\nMulti-Field aggregation bucket containing field values and the number of logs.","title":"MultiFieldAggregationBucket","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"},"keys":{"type":"object","description":"x-displayName: \"Keys\"\nKeys contain the name/value pair that identifies the unique combination of multiple key fields\nx-example: \"{\"SRC_IP\": \"10.10.10.1\", \"COUNTRY\": \"US\"}\"","title":"keys"},"order_by":{"$ref":"#/components/schemas/logOrderByData"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nSub aggregation data for the multi field aggregation bucket","title":"sub aggregation"}}},"logMultiFieldAggregationData":{"type":"object","description":"x-displayName: \"Multi-Field Aggregation Data\"\nMulti-Field Aggregation data","title":"MultiFieldAggregationData","properties":{"buckets":{"type":"array","description":"x-displayName: \"Buckets\"\nLists of buckets containing field values and the corresponding log count","title":"buckets","items":{"$ref":"#/components/schemas/logMultiFieldAggregationBucket"}}}},"logMultiFieldSubAggregationData":{"type":"object","description":"x-displayName: \"Multi Field SubAggregation\"\nField subaggregation data","title":"MultiFieldSubAggregationData","properties":{"avg_aggregation":{"$ref":"#/components/schemas/logAvgAggregationData"},"cardinality_aggregation":{"$ref":"#/components/schemas/logCardinalityAggregationData"},"max_aggregation":{"$ref":"#/components/schemas/logMaxAggregationData"},"min_aggregation":{"$ref":"#/components/schemas/logMinAggregationData"},"top_hits_aggregation":{"$ref":"#/components/schemas/logTopHitsAggregationData"}}},"logMultiFilterAggregationData":{"type":"object","description":"x-displayName: \"Multi Filter Aggregation Data\"\nMulti Filter Aggregation data","title":"MultiFilterAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 45\n\nnumber of logs in this bucket","title":"count","format":"uint64"}}},"logOrderByData":{"type":"object","description":"x-displayName: \"Order by Data\"\nOrder by data","title":"OrderByData","properties":{"metrics_aggregation":{"$ref":"#/components/schemas/logMetricsAggregationData"}}},"logPercentileAggregationData":{"type":"object","description":"x-displayName: \"Percentile Aggregation Data\"\nPercentile Aggregation data","title":"PercentileAggregationData","properties":{"key":{"type":"number","description":"x-displayName: \"Key\"\nx-example: 99.0","title":"key","format":"double"},"value":{"type":"number","description":"x-displayName: \"Value\"\nx-example: 985.0\n\nvalue corresponding to the key percent","title":"value","format":"double"}}},"logPlatformEventAggregationRequest":{"type":"object","description":"Request to get only aggregation data for platform events","title":"PlatformEventAggregationRequest","x-displayname":"Platform event Aggregation Request","x-ves-proto-message":"ves.io.schema.log.PlatformEventAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in platform events may be specified in the query.\n   user - user name\n   resource_type - resource type\n   resource - resource\n   event_type - event type \n   \n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\n Example: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\n Optional: If not specified, all the platform events matching the given tenant and namespace are returned\n\nExample: ` \"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logPlatformEventRequest":{"type":"object","description":"Request to fetch platform events","title":"PlatformEventRequest","x-displayname":"Platform event Request","x-ves-proto-message":"ves.io.schema.log.PlatformEventRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"include_config_changes":{"type":"boolean","description":"\n Platform events of type config change captures old and new object blobs. This flag is used to include the blobs in \n response. It is introduced to reduce any performance impact UI may face while rendering. \n Optional: default is false ","title":"include_config_changes","format":"boolean","x-displayname":"Exclude config changes"},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch audit logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in platform events may be specified in the query.\n   user - user name\n   resource_type - resource type\n   resource - resource\n   event_type - event type \n   \n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then platform events matching ALL the matchers will be returned in the response.\n Example: query={resource_type=\"CUSTOMER_EDGE\"} will return all platform events with resource_type equals CUSTOMER_EDGE\n\n Optional: If not specified, all the platform events matching the given tenant and namespace are returned\n\nExample: ` \"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"{user=\\\"abc\\\", rsp_code=\\\"404\\\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logTopHitsAggregationData":{"type":"object","description":"x-displayName: \"TopHits Aggregation Data\"\nTop Hits Aggregation Data.","title":"TopHitsAggregationData","properties":{"count":{"type":"string","description":"x-displayName: \"Count\"\nx-example: 100\nCount of top hit values","title":"count","format":"uint64"},"documents":{"type":"array","description":"x-displayName: \"Documents\"\ndocument values","title":"documents","items":{"type":"string"}}}},"logVK8SAuditLogAggregationRequest":{"type":"object","description":"Request to get only aggregation data for vK8s audit logs","title":"VK8SAuditLogAggregationRequest","x-displayname":"vK8s Audit Log Aggregation Request","x-ves-proto-message":"ves.io.schema.log.VK8SAuditLogAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user.username - user name\n   sourceIPs - source ip\n   verb - method\n   objectRef.resource - K8s resource\n   requestURI - request URI\n <value> := string\n <operator> := [\"=\"|\"!=\"]\n   = : equal to\n   != : not equal to\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={objectRef.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace will be considered for aggregation\n\nExample: ` \"query={objectRef.resource=\"deployments\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={objectRef.resource=\"deployments\"}"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logVK8SAuditLogRequest":{"type":"object","description":"Request to fetch Virtual K8s audit logs","title":"VK8SAuditLogRequest","x-displayname":"vK8s Audit Log Request","x-ves-proto-message":"ves.io.schema.log.VK8SAuditLogRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the log response. If the number of logs that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch audit logs whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of logs returned in the response\n Optional: If not specified, first or last 500 log messages that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch vK8s audit logs for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in audit log may be specified in the query.\n   user.username - user name\n   sourceIPs - source ip\n   verb - method\n   objectRef.resource - K8s resource\n   requestURI - request URI\n <value> := string\n <operator> := [\"=\"|\"!=\"|\"=~\"|\"!~\"]\n   = : equal to\n   != : not equal to\n   =~ : regex match\n   !~ : not regex match\n When more than one matcher is specified in the query, then audit logs matching ALL the matchers will be returned in the response.\n Example: query={objectRef.resource=\"deployments\"} will return all vK8s audit logs for all deployment objects in the given namespace\n\n Optional: If not specified, all the audit logs matching the given tenant and namespace are returned\n\nExample: ` \"query={objectRef.resource=\"deployments\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={objectRef.resource=\"deployments\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of log messages (or all log messages) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of logs until there are no more logs left to return. The number of messages in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch audit logs whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logVK8SEventsAggregationRequest":{"type":"object","description":"Request to get only aggregation data for vK8s events","title":"vK8s Events Aggregation Request","x-displayname":"Virtual K8s Events Aggregation Request","x-ves-proto-message":"ves.io.schema.log.VK8SEventsAggregationRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch vK8s events whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"namespace":{"type":"string","description":" get aggregation data for a given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in the event may be specified in the query.\n   involvedObject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\n   involvedObject.name - Name of the object\n   type - Type of event such as Warning or Normal\n   reason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\n   source.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\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, all the vK8s events for the given tenant and namespace are returned\n\nExample: ` \"query={involvedObject.kind=\"Pod\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={involvedObject.kind=\"Pod\"}"},"start_time":{"type":"string","description":" fetch vK8s events whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logVK8SEventsRequest":{"type":"object","description":"Request to fetch Virtual K8s events","title":"vK8s Events Request","x-displayname":"vK8s Events Request","x-ves-proto-message":"ves.io.schema.log.VK8SEventsRequest","properties":{"aggs":{"type":"object","description":" Aggregations provide summary/analytics data over the events response. If the number of events that matched the query\n is large and cannot be returned in a single response message, user can get helpful insights/summary using aggregations.\n The aggregations are key'ed by user-defined aggregation name. The response will be key'ed with the same name.\n Optional","title":"aggregations","x-displayname":"Aggregations"},"end_time":{"type":"string","description":" fetch vK8s events whose timestamp <= end_time\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: ` \"2019-09-24T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"end time","x-displayname":"End Time","x-ves-example":"2019-09-24T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}},"limit":{"type":"integer","description":" limits the number of vK8s events returned in the response\n Optional: If not specified, first or last 500 events that matches the query (depending on the sort order) will be returned in the response.\n           The maximum value for limit is 500.\n\nExample: ` \"100\"`","title":"limit","format":"int32","x-displayname":"Limit","x-ves-example":"100"},"namespace":{"type":"string","description":" fetch vK8s events for the given namespace\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"},"query":{"type":"string","description":" query is used to specify the list of matchers\n syntax for query := {[<matcher>]}\n <matcher> := <field_name><operator>\"<value>\"\n <field_name> := string\n  One or more of the following fields in the event may be specified in the query.\n   involvedObject.kind - The object that this event is about, like Pod, Deployment, Node, etc.\n   involvedObject.name - Name of the object\n   type - Type of event such as Warning or Normal\n   reason - A one-word description for an event. For example Pending, Running, Succeeded, Failed are some of values for reason that indicate the phase of a Pod lifecycle.\n   source.component - The K8s component reporting the event such as kubelet, kube-scheduler, etc.,\n   site - Name of the site\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, all the vK8s events for the given tenant and namespace are returned\n\nExample: ` \"query={involvedObject.kind=\"Pod\"}\"`","title":"query","x-displayname":"Query","x-ves-example":"query={involvedObject.kind=\"Pod\"}"},"scroll":{"type":"boolean","description":" Scroll is used to retrieve large number of events (or all events) that matches the query.\n If scroll is set to true, the scroll_id in the response can be used in the scroll API to fetch the next\n batch of events until there are no more events left to return. The number of events in each batch is determined\n by the limit field.\n Note: Scroll is used for processing large amount of data and therefore is not intended for real time user request.\n Optional: default is false\n\nExample: ` \"true\"`","title":"scroll","format":"boolean","x-displayname":"Scroll","x-ves-example":"true"},"sort":{"$ref":"#/components/schemas/schemaSortOrder"},"start_time":{"type":"string","description":" fetch vK8s events whose timestamp >= start_time\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: ` \"2019-09-23T12:30:11.733Z\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.query_time: true\n","title":"start time","x-displayname":"Start Time","x-ves-example":"2019-09-23T12:30:11.733Z","x-ves-validation-rules":{"ves.io.schema.rules.string.query_time":"true"}}}},"logaccess_logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"avg_aggregation":{"$ref":"#/components/schemas/access_logAvgAggregation"},"cardinality_aggregation":{"$ref":"#/components/schemas/logaccess_logCardinalityAggregation"},"date_aggregation":{"$ref":"#/components/schemas/logaccess_logDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logaccess_logFieldAggregation"},"max_aggregation":{"$ref":"#/components/schemas/access_logMaxAggregation"},"min_aggregation":{"$ref":"#/components/schemas/access_logMinAggregation"},"multi_field_aggregation":{"$ref":"#/components/schemas/access_logMultiFieldAggregation"}}},"logaccess_logCardinalityAggregation":{"type":"object","description":"x-displayName: \"Cardinality Aggregation\"\nGet approximate count of distinct values for the field in the access log.","title":"Cardinality Aggregation","properties":{"field":{"$ref":"#/components/schemas/logaccess_logKeyField"}}},"logaccess_logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate access logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket","title":"sub aggregation"}}},"logaccess_logDateSubAggregation":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\nAggregate access logs in each date bucket based on one of the sub aggregation types","title":"Date SubAggregation","properties":{"field_aggregation":{"$ref":"#/components/schemas/logaccess_logFieldAggregation"},"multi_field_aggregation":{"$ref":"#/components/schemas/access_logMultiFieldAggregation"}}},"logaccess_logFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate access logs based on the key fields in the log.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logaccess_logKeyField"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each field aggregation bucket.","title":"sub aggregation"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logaccess_logKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nAccess log can be aggregated based on these fields.\n\n - API_ENDPOINT: x-displayName: \"API Endpoint\"\n - APP_TYPE: x-displayName: \"App Type\"\n - AUTHORITY: x-displayName: \"Authority\"\n - ASN: x-displayName: \"ASN\"\n - BROWSER_TYPE: x-displayName: \"Browser Type\"\n - CITY: x-displayName: \"City\"\n - COUNTRY: x-displayName: \"Country\"\n - DEVICE_TYPE: x-displayName: \"Device Type\"\n - DST: x-displayName: \"Destination Service\"\n - DST_INSTANCE: x-displayName: \"Destination Instance\"\n - DST_SITE: x-displayName: \"Destination Site\"\n - METHOD: x-displayName: \"Method\"\n - SCHEME: x-displayName: \"Scheme\"\n - REMOTE_LOCATION: x-displayName: \"Remote Location\"\n - REQ_PATH: x-displayName: \"Request Path\"\n - RSP_CODE: x-displayName: \"Response Code\"\n - RSP_CODE_CLASS: x-displayName: \"Response Code Class\"\n - RSP_CODE_DETAILS: x-displayName: \"Response Code Details\"\n - SRC: x-displayName: \"Source Service\"\n - SRC_INSTANCE: x-displayName: \"Source Instance\"\n - SRC_IP: x-displayName: \"Source IP\"\n - SRC_SITE: x-displayName: \"Source Site\"\n - TLS_CIPHER_SUITE: x-displayName: \"TLS Cipher Suite\"\n - TLS_FINGERPRINT: x-displayName: \"TLS Fingerprint\"\n - TLS_VERSION: x-displayName: \"TLS Version\"\n - USER: x-displayName: \"User\"\n - VH_NAME: x-displayName: \"Virtual Host Name\"\n - VH_TYPE: x-displayName: \"Virtual Host Type\"\n - VISITOR_ID: x-displayName: \"Visitor Id\"\n - JA4_TLS_FINGERPRINT: x-displayName: \"JA4 TLS Fingerprint\"","title":"Key Field","enum":["API_ENDPOINT","APP_TYPE","AUTHORITY","ASN","BROWSER_TYPE","CITY","COUNTRY","DEVICE_TYPE","DST","DST_INSTANCE","DST_SITE","METHOD","SCHEME","REMOTE_LOCATION","REQ_PATH","RSP_CODE","RSP_CODE_CLASS","RSP_CODE_DETAILS","SRC","SRC_INSTANCE","SRC_IP","SRC_SITE","TLS_CIPHER_SUITE","TLS_FINGERPRINT","TLS_VERSION","USER","VH_NAME","VH_TYPE","VISITOR_ID","JA4_TLS_FINGERPRINT"],"default":"API_ENDPOINT"},"logaudit_logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logaudit_logDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logaudit_logFieldAggregation"}}},"logaudit_logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate access logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logaudit_logFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate access logs based on the key fields in the log.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logaudit_logKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logaudit_logKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\n\n - AUTHORITY: x-displayName: \"Authority\"\n - DST: x-displayName: \"Destination Service\"\n - DST_INSTANCE: x-displayName: \"Destination Instance\"\n - DST_SITE: x-displayName: \"Destination Site\"\n - METHOD: x-displayName: \"Method\"\n - SCHEME: x-displayName: \"Scheme\"\n - REQ_PATH: x-displayName: \"Request Path\"\n - RSP_CODE: x-displayName: \"Response Code\"\n - SRC: x-displayName: \"Source Service\"\n - SRC_INSTANCE: x-displayName: \"Source Instance\"\n - SRC_SITE: x-displayName: \"Source Site\"\n - TRANSPORT: x-displayName: \"Trasnsport\"\n - USER: x-displayName: \"User\"","title":"KeyField","enum":["AUTHORITY","DST","DST_INSTANCE","DST_SITE","METHOD","SCHEME","REQ_PATH","RSP_CODE","SRC","SRC_INSTANCE","SRC_SITE","TRANSPORT","USER"],"default":"AUTHORITY"},"logfirewall_logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"cardinality_aggregation":{"$ref":"#/components/schemas/logfirewall_logCardinalityAggregation"},"date_aggregation":{"$ref":"#/components/schemas/logfirewall_logDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logfirewall_logFieldAggregation"}}},"logfirewall_logCardinalityAggregation":{"type":"object","description":"x-displayName: \"Cardinality Aggregation\"\nGet approximate count of distinct values for the field in the firewall log.","title":"Cardinality Aggregation","properties":{"field":{"$ref":"#/components/schemas/logfirewall_logKeyField"}}},"logfirewall_logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate firewall logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"},"sub_aggs":{"type":"object","description":"x-displayName: \"Sub Aggregation\"\nThis option provides sub-aggregation for each date bucket","title":"sub aggregation"}}},"logfirewall_logDateSubAggregation":{"type":"object","description":"x-displayName: \"Date SubAggregation\"\nAggregate firewall logs in each date bucket based on one of the sub aggregation types","title":"Date SubAggregation","properties":{"field_aggregation":{"$ref":"#/components/schemas/logfirewall_logFieldAggregation"}}},"logfirewall_logFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate firewall logs based on the key fields in the log.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logfirewall_logKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logfirewall_logKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nFirewall log can be aggregated based on these fields.\n\n - SITE: x-displayName: \"Site\"\n - SRC_IP: x-displayName: \"Source IP Address\"\n - DST_IP: x-displayName: \"Destination IP Address\"\n - POLICY: x-displayName: \"Policy\"\n - POLICY_RULE: x-displayName: \"Policy Rule\"\n - POLICY_HITS_RESULT: x-displayName: \"Policy Hit Result\"","title":"Key Field","enum":["SITE","SRC_IP","DST_IP","POLICY","POLICY_RULE","POLICY_HITS_RESULT"],"default":"SITE"},"logk8s_audit_logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logk8s_audit_logDateAggregation"}}},"logk8s_audit_logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate K8s audit logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logk8s_eventsAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the K8s events","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logk8s_eventsDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logk8s_eventsFieldAggregation"}}},"logk8s_eventsDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate K8s events based on timestamp in the event","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logk8s_eventsFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate K8s events based on the key fields.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logk8s_eventsKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logk8s_eventsKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nK8s events can be aggregated based on these fields.\n\n - INVOLVED_OBJECT_KIND: x-displayName: \"Involved Object Kind\"\n - INVOLVED_OBJECT_NAME: x-displayName: \"Involved Object Name\"\n - TYPE: x-displayName: \"Type\"\n - REASON: x-displayName: \"Reason\"\n - SOURCE_COMPONENT: x-displayName: \"Source Component\"","title":"Key Field","enum":["INVOLVED_OBJECT_KIND","INVOLVED_OBJECT_NAME","TYPE","REASON","SOURCE_COMPONENT"],"default":"INVOLVED_OBJECT_KIND"},"logplatform_eventAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the platform events","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logplatform_eventDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logplatform_eventFieldAggregation"}}},"logplatform_eventDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate platform events based on timestamp in the event","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logplatform_eventFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate platform events based on the key fields.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logplatform_eventKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logplatform_eventKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nplatform events can be aggregated based on these fields.\n\n - EVENT_TYPE: x-displayName: \"Event type\"","title":"Key Field","enum":["EVENT_TYPE"],"default":"EVENT_TYPE"},"logvk8s_audit_logAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the log response","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logvk8s_audit_logDateAggregation"}}},"logvk8s_audit_logDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate vK8s audit logs based on timestamp in the log","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logvk8s_eventsAggregationRequest":{"type":"object","description":"x-displayName: \"Aggregation Request\"\nAggregation request to provide analytics data over the vK8s events","title":"Aggregation Request","properties":{"date_aggregation":{"$ref":"#/components/schemas/logvk8s_eventsDateAggregation"},"field_aggregation":{"$ref":"#/components/schemas/logvk8s_eventsFieldAggregation"}}},"logvk8s_eventsDateAggregation":{"type":"object","description":"x-displayName: \"Date Aggregation\"\nAggregate vK8s events based on timestamp in the event","title":"Date Aggregation","properties":{"step":{"type":"string","description":"x-displayName: \"Step\"\nx-required\nx-example: \"5m\"\n\nstep is the resolution width, which determines the number of the data points [x-axis (time)] to be returned in the response.\nThe timestamps in the response will be t1=start_time, t2=t1+step, ... tn=tn-1+step, where tn <= end_time.\nFormat: [0-9][smhd], where s - seconds, m - minutes, h - hours, d - days","title":"step"}}},"logvk8s_eventsFieldAggregation":{"type":"object","description":"x-displayName: \"Field Aggregation\"\nAggregate vK8s events based on the key fields.","title":"Field Aggregation","properties":{"field":{"$ref":"#/components/schemas/logvk8s_eventsKeyField"},"topk":{"type":"integer","description":"x-displayName: \"TopK\"\nx-example: \"5\"\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.","title":"topk","format":"int64"}}},"logvk8s_eventsKeyField":{"type":"string","description":"x-displayName: \"Key Field\"\nvK8s events can be aggregated based on these fields.\n\n - INVOLVED_OBJECT_KIND: x-displayName: \"Involved Object Kind\"\n - INVOLVED_OBJECT_NAME: x-displayName: \"Involved Object Name\"\n - TYPE: x-displayName: \"Type\"\n - REASON: x-displayName: \"Reason\"\n - SOURCE_COMPONENT: x-displayName: \"Source Component\"\n - SITE: x-displayName: \"Site\"","title":"Key Field","enum":["INVOLVED_OBJECT_KIND","INVOLVED_OBJECT_NAME","TYPE","REASON","SOURCE_COMPONENT","SITE"],"default":"INVOLVED_OBJECT_KIND"},"schemaMetricLabelOp":{"type":"string","description":"The operator to use when filtering metrics based on label values.\n","title":"Metric Label Operator","enum":["EQ","NEQ"],"default":"EQ","x-displayname":"Metric Label Operator","x-ves-proto-enum":"ves.io.schema.MetricLabelOp"},"schemaSortOrder":{"type":"string","description":"Sort algorithm\n\nSort in descending order\nSort in ascending order","title":"SortOrder","enum":["DESCENDING","ASCENDING"],"default":"DESCENDING","x-displayname":"Sort Order","x-ves-proto-enum":"ves.io.schema.SortOrder"},"schemaTrendSentiment":{"type":"string","description":"x-displayName: \"Trend Sentiment\"\ntrend sentiment\n\n - TREND_SENTIMENT_NONE: x-displayName: \"None\"\n - TREND_SENTIMENT_POSITIVE: x-displayName: \"Positive\"\nIndicates trend sentiment is positive\n - TREND_SENTIMENT_NEGATIVE: x-displayName: \"Negative\"\nIndicates trend sentiment is negative.","title":"Trend Sentiment","enum":["TREND_SENTIMENT_NONE","TREND_SENTIMENT_POSITIVE","TREND_SENTIMENT_NEGATIVE"],"default":"TREND_SENTIMENT_NONE"},"schemaTrendValue":{"type":"object","description":"x-displayName: \"Trend Value\"\nTrend value contains trend value, trend sentiment and trend calculation description and window size.","title":"Trend Value","properties":{"description":{"type":"string","description":"x-displayName: \"Description\"\nx-example: \"Trend was calculated by comparing the avg of window size intervals of end-start Time and last window time interval\"\ndescription of the method used to calculate trend.","title":"Description"},"previous_value":{"type":"string","description":"x-displayName: \"Previous Value\"\nx-example: \"200.00\"","title":"Previous Value"},"sentiment":{"$ref":"#/components/schemas/schemaTrendSentiment"},"value":{"type":"string","description":"x-displayName: \"Value\"\nx-example: \"-15\"","title":"Value"}}},"schemalogLabel":{"type":"string","description":"Metrics used to construct the query for external connector request\n\nIndicates the field not being set\nExternal connector IP\nExternal connector node","title":"Label","enum":["LABEL_NONE","LABEL_EXTERNAL_CONNECTOR_IP","LABEL_EXTERNAL_CONNECTOR_NODE"],"default":"LABEL_NONE","x-displayname":"Label","x-ves-proto-enum":"ves.io.schema.log.Label"}}}}