@robinmordasiewicz/f5xc-terraform-mcp 2.3.0 → 2.4.3

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

@@ -0,0 +1 @@
+{"openapi":"3.0.0","info":{"title":"F5 Distributed Cloud Services API for ves.io.schema.namespace","description":"namespace creates logical independent workspace within a tenant. Within a namespace contained objects should have unique names.\n\n    Object within a namespace can only refer to objects within the same namespace or shared namespace or ves-io/shared namespace\n\n    All monitoring is scoped by namespace\n\n    List within namespace lists objects within same namespace or shared namespace or ves-io/shared namespace\n\n    User roles can be scoped by namespace\n\n    The 'namespace' value of a namespace object itself is empty string","version":""},"paths":{"/api/web/namespaces":{"get":{"summary":"List Namespace","description":"List the set of namespace in a namespace","operationId":"ves.io.schema.namespace.API.List","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceListResponse"}}}},"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":"x-example: \"ns1\"\nNamespace to scope the listing of namespace","in":"query","required":false,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"label_filter","description":"x-example: \"env in (staging, testing), tier in (web, db)\"\nA LabelSelectorType expression that every item in list response will satisfy","in":"query","required":false,"x-displayname":"Label Filter","schema":{"type":"string"}},{"name":"report_fields","description":"x-example: \"\"\nExtra fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"report_status_fields","description":"x-example: \"\"\nExtra status fields to return along with summary fields","in":"query","required":false,"x-displayname":"Report Status Fields","explode":true,"schema":{"type":"array","items":{"type":"string"}}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-api-list"},"x-ves-proto-rpc":"ves.io.schema.namespace.API.List"},"post":{"summary":"Create Namespace","description":"Creates a new namespace. Name of the object is name of the name space.","operationId":"ves.io.schema.namespace.API.Create","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceCreateResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceCreateRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-api-create"},"x-ves-proto-rpc":"ves.io.schema.namespace.API.Create"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/system/all_application_inventory":{"post":{"summary":"All Application Objects Inventory","description":"AllApplicationInventory returns inventory of configured application related objects for all namespaces.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApplicationInventoryResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceAllApplicationInventoryRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-allapplicationinventory"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventory"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/system/all_application_inventory_waf_filters":{"post":{"summary":"All Application Objects Inventory with WAF Filters","description":"AllApplicationInventoryWaf returns inventory of configured application related objects for all namespaces with WAF Filters.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventoryWaf","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceAllApplicationInventoryWafFilterResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceAllApplicationInventoryWafFilterRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-allapplicationinventorywaf"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.AllApplicationInventoryWaf"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/system/api_endpoints/all_ns_stats":{"post":{"summary":"Get Api Endpoints Stats for All Namespaces","description":"Get api endpoints stats for all Namespaces. This API is specific to system namespace","operationId":"ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStatsAllNamespaces","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApiEndpointsStatsNSRsp"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApiEndpointsStatsAllNSReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacemlcustomapi-getapiendpointsstatsallnamespaces"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStatsAllNamespaces"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceMLCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/evaluate-api-access":{"post":{"summary":"Evaluate API Access","description":"EvaluateAPIAccess can evaluate multiple lists of API url, method under a namespace for a given user of a tenant.","operationId":"ves.io.schema.namespace.CustomAPI.EvaluateAPIAccess","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceEvaluateAPIAccessResp"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceEvaluateAPIAccessReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-customapi-evaluateapiaccess"},"x-ves-proto-rpc":"ves.io.schema.namespace.CustomAPI.EvaluateAPIAccess"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/evaluate-batch-api-access":{"post":{"summary":"Evaluate Batch API Access","description":"EvaluateBatchAPIAccess can evaluate multiple lists of API url, method under a batch of namespaces for a given user of a tenant.","operationId":"ves.io.schema.namespace.CustomAPI.EvaluateBatchAPIAccess","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceEvaluateBatchAPIAccessResp"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceEvaluateBatchAPIAccessReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-customapi-evaluatebatchapiaccess"},"x-ves-proto-rpc":"ves.io.schema.namespace.CustomAPI.EvaluateBatchAPIAccess"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/system/lookup-user-roles":{"post":{"summary":"Lookup User Roles","description":"LookupUserRoles returns roles for the the given user, namespace","operationId":"ves.io.schema.namespace.CustomAPI.LookupUserRoles","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceLookupUserRolesResp"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceLookupUserRolesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-customapi-lookupuserroles"},"x-ves-proto-rpc":"ves.io.schema.namespace.CustomAPI.LookupUserRoles"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/system/networking_inventory":{"post":{"summary":"Networking Objects Inventory","description":"NetworkingInventory returns inventory of configured networking related objects for the tenant.\nInventory of system-wide objects (global networks, sites, site mesh groups, etc) is returned.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.NetworkingInventory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceNetworkingInventoryResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceNetworkingInventoryRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-networkinginventory"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.NetworkingInventory"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/cloud-data/namespaces/system/suggest-values":{"post":{"summary":"Suggest Values","description":"Returns suggested values for the specified field in the given Create/Replace/Custom request","operationId":"ves.io.schema.namespace.NamespaceCloudDataCustomAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemanamespaceSuggestValuesResp"}}}},"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"}}}}},"requestBody":{"$ref":"#/components/requestBodies/namespaceSuggestValuesReq"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespaceclouddatacustomapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCloudDataCustomAPI.SuggestValues"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCloudDataCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/system/update_allow_advertise_on_public":{"post":{"summary":"Update allow advertise on public.","description":"UpdateAllowAdvertiseOnPublic can update a config to allow advertise on public.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.UpdateAllowAdvertiseOnPublic","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceUpdateAllowAdvertiseOnPublicResp"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceUpdateAllowAdvertiseOnPublicReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-updateallowadvertiseonpublic"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.UpdateAllowAdvertiseOnPublic"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/system/validate_rules":{"post":{"summary":"Validate Rules","description":"ValidateRules returns whether the value is valid or not for the specified validator rules.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.ValidateRules","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceValidateRulesResponse"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceValidateRulesReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-validaterules"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.ValidateRules"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{metadata.name}":{"put":{"summary":"Replace Namespace","description":"Replaces attributes of a namespace including its metadata like labels, description etc.","operationId":"ves.io.schema.namespace.API.Replace","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceReplaceResponse"}}}},"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":"metadata.name","description":"name\n\nx-example: \"acmecorp-web\"\nThe configuration object to be replaced will be looked up by name","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceReplaceRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-api-replace"},"x-ves-proto-rpc":"ves.io.schema.namespace.API.Replace"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/config/namespaces/{namespace}/active_alert_policies":{"get":{"summary":"Get Active Alert Policies","description":"GetActiveAlertPolicies returns the list of active alert policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveAlertPolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceGetActiveAlertPoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-getactivealertpolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveAlertPolicies"},"post":{"summary":"Set Active Alert Policies","description":"SetActiveAlertPolicies sets the active alert policies for the namespace\nAn emtpy list in the request will clear the active alert policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveAlertPolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveAlertPoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveAlertPoliciesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-setactivealertpolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveAlertPolicies"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/active_network_policies":{"get":{"summary":"Get Active Network Policies","description":"GetActiveNetworkPolicies resturn the list of active network policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveNetworkPolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceGetActiveNetworkPoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-getactivenetworkpolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveNetworkPolicies"},"post":{"summary":"Set Active Network Policies","description":"SetActiveNetworkPolicies sets the active network policies for the namespace\nAn emtpy list in the request will clear the active network policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveNetworkPolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveNetworkPoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveNetworkPoliciesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-setactivenetworkpolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveNetworkPolicies"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/active_service_policies":{"get":{"summary":"Get Active Service Policies","description":"GetActiveServicePolicies resturn the list of active service policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveServicePolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceGetActiveServicePoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-getactiveservicepolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.GetActiveServicePolicies"},"post":{"summary":"Set Active Service Policies","description":"SetActiveServicePolicies sets the active service policies for the namespace\nAn emtpy list in the request will clear the active service policies for the namespace","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveServicePolicies","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveServicePoliciesResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetActiveServicePoliciesRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-setactiveservicepolicies"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.SetActiveServicePolicies"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/ml/data/namespaces/{namespace}/api_endpoints/stats":{"post":{"summary":"Get Api Endpoints Stats for Namespace","description":"Get api endpoints stats for the given Namespace","operationId":"ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStats","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApiEndpointsStatsNSRsp"}}}},"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: \"shared\"\nNamespace of the App type for current request","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApiEndpointsStatsNSReq"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacemlcustomapi-getapiendpointsstats"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceMLCustomAPI.GetApiEndpointsStats"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceMLCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/application_inventory":{"post":{"summary":"Application Objects Inventory","description":"ApplicationInventory returns inventory of configured application related objects for the tenant.\nInventory of namespaced objects (HTTP LBs, TCP LBs, etc) in a particular namespace is returned.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.ApplicationInventory","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApplicationInventoryResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceApplicationInventoryRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-applicationinventory"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.ApplicationInventory"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/config/namespaces/{namespace}/fast_acls_for_internet_vips":{"get":{"summary":"Get FastACLs For Internet VIPs","description":"GetFastACLsForInternetVIPs Returns the list of Active FastACLs for Internet VIPs.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.GetFastACLsForInternetVIPs","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceGetFastACLsForInternetVIPsResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-getfastaclsforinternetvips"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.GetFastACLsForInternetVIPs"},"post":{"summary":"Set FastACLs For Internet VIPs","description":"SetFastACLsForInternetVIPs activates the passed list of FastACLs for Internet VIPs.\nAn emtpy list in the request will clear FastACLs for Internet VIPs.","operationId":"ves.io.schema.namespace.NamespaceCustomAPI.SetFastACLsForInternetVIPs","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetFastACLsForInternetVIPsResponse"}}}},"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: \"ns1\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSetFastACLsForInternetVIPsRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-namespacecustomapi-setfastaclsforinternetvips"},"x-ves-proto-rpc":"ves.io.schema.namespace.NamespaceCustomAPI.SetFastACLsForInternetVIPs"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.NamespaceCustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{namespace}/suggest-values":{"post":{"summary":"Suggest Values","description":"SuggestValues returns suggested values for the specified field in the given Create/Replace/Custom request.","operationId":"ves.io.schema.namespace.CustomAPI.SuggestValues","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/schemanamespaceSuggestValuesResp"}}}},"401":{"description":"Returned when operation is not authorized","content":{"application/json":{"schema":{"format":"string"}}}},"403":{"description":"Returned when there is no permission to access resource","content":{"application/json":{"schema":{"format":"string"}}}},"404":{"description":"Returned when resource is not found","content":{"application/json":{"schema":{"format":"string"}}}},"409":{"description":"Returned when operation on resource is conflicting with current value","content":{"application/json":{"schema":{"format":"string"}}}},"429":{"description":"Returned when operation has been rejected as it is happening too frequently","content":{"application/json":{"schema":{"format":"string"}}}},"500":{"description":"Returned when server encountered an error in processing API","content":{"application/json":{"schema":{"format":"string"}}}},"503":{"description":"Returned when service is unavailable temporarily","content":{"application/json":{"schema":{"format":"string"}}}},"504":{"description":"Returned when server timed out processing request","content":{"application/json":{"schema":{"format":"string"}}}}},"parameters":[{"name":"namespace","description":"namespace\n\nx-example: \"foobar\"\nNamespace in which the suggestions are scoped.","in":"path","required":true,"x-displayname":"Namespace","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/namespaceSuggestValuesReq"},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-customapi-suggestvalues"},"x-ves-proto-rpc":"ves.io.schema.namespace.CustomAPI.SuggestValues"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"},"/api/web/namespaces/{name}":{"get":{"summary":"Get Namespace","description":"This is the read representation of the namespace object.","operationId":"ves.io.schema.namespace.API.Get","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceGetResponse"}}}},"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":"name","description":"name\n\nx-example: \"name\"\nThe name of the configuration object to be fetched","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}},{"name":"namespace","description":"x-example: \"ns1\"\nThe namespace in which the configuration object is present","in":"query","required":false,"x-displayname":"Namespace","schema":{"type":"string"}},{"name":"response_format","description":"The format in which the configuration object is to be fetched. This could be for example\n    - in GetSpec form for the contents of object\n    - in CreateRequest form to create a new similar object\n    - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object","in":"query","required":false,"x-displayname":"Broken Referred Objects","schema":{"type":"string","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"}}],"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-api-get"},"x-ves-proto-rpc":"ves.io.schema.namespace.API.Get"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.API","x-ves-proto-service-type":"AUTO_CRUD_PUBLIC"},"/api/web/namespaces/{name}/cascade_delete":{"post":{"summary":"Cascade Delete","description":"CascadeDelete will delete the namespace and all configuration objects like virtual_hosts etc.\nunder it. Use this only if the entire namespace and its contents are to be wiped out.","operationId":"ves.io.schema.namespace.CustomAPI.CascadeDelete","responses":{"200":{"description":"A successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceCascadeDeleteResponse"}}}},"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":"name","description":"name\n\nx-example: \"value\"\nThe name of the namespace","in":"path","required":true,"x-displayname":"Name","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceCascadeDeleteRequest"}}},"required":true},"externalDocs":{"description":"Examples of this operation","url":"https://docs.cloud.f5.com/docs-v2/platform/reference/api-ref/ves-io-schema-namespace-customapi-cascadedelete"},"x-ves-proto-rpc":"ves.io.schema.namespace.CustomAPI.CascadeDelete"},"x-displayname":"Namespace","x-ves-proto-service":"ves.io.schema.namespace.CustomAPI","x-ves-proto-service-type":"CUSTOM_PUBLIC"}},"x-displayname":"Namespace","x-ves-proto-package":"ves.io.schema.namespace","components":{"requestBodies":{"namespaceSuggestValuesReq":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/namespaceSuggestValuesReq"}}},"required":true}},"schemas":{"alert_policy_setAlertPolicyStatus":{"type":"object","x-ves-proto-message":"ves.io.schema.alert_policy_set.AlertPolicyStatus","properties":{"policy":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"reason":{"type":"array","description":" A human-readable description of why this status is in the\n \"Partially Active\" or \"Inactive\" status. The value will be empty for\n \"Active\" status.","title":"Reason","items":{"type":"string"},"x-displayname":"Reason"},"status":{"type":"string","description":" Staus of the alert policy\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Active\\\",\\\"Inactive\\\",\\\"Partially Active\\\"]\n","title":"Status","x-displayname":"Status","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Active\\\",\\\"Inactive\\\",\\\"Partially Active\\\"]"}}}},"app_firewallAppFirewallViolationType":{"type":"string","description":"List of all supported Violation Types\n\nVIOL_NONE\nVIOL_FILETYPE\nVIOL_METHOD\nVIOL_MANDATORY_HEADER\nVIOL_HTTP_RESPONSE_STATUS\nVIOL_REQUEST_MAX_LENGTH\nVIOL_FILE_UPLOAD\nVIOL_FILE_UPLOAD_IN_BODY\nVIOL_XML_MALFORMED\nVIOL_JSON_MALFORMED\nVIOL_ASM_COOKIE_MODIFIED\nVIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS\nVIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE\nVIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT\nVIOL_HTTP_PROTOCOL_NULL_IN_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION\nVIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START\nVIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING\nVIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS\nVIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER\nVIOL_EVASION_DIRECTORY_TRAVERSALS\nVIOL_MALFORMED_REQUEST\nVIOL_EVASION_MULTIPLE_DECODING\nVIOL_DATA_GUARD\nVIOL_EVASION_APACHE_WHITESPACE\nVIOL_COOKIE_MODIFIED\nVIOL_EVASION_IIS_UNICODE_CODEPOINTS\nVIOL_EVASION_IIS_BACKSLASHES\nVIOL_EVASION_PERCENT_U_DECODING\nVIOL_EVASION_BARE_BYTE_DECODING\nVIOL_EVASION_BAD_UNESCAPE\nVIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING\nVIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST\nVIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS\nVIOL_ENCODING\nVIOL_COOKIE_MALFORMED\nVIOL_GRAPHQL_FORMAT\nVIOL_GRAPHQL_MALFORMED\nVIOL_GRAPHQL_INTROSPECTION_QUERY","title":"App Firewall Violation Type","enum":["VIOL_NONE","VIOL_FILETYPE","VIOL_METHOD","VIOL_MANDATORY_HEADER","VIOL_HTTP_RESPONSE_STATUS","VIOL_REQUEST_MAX_LENGTH","VIOL_FILE_UPLOAD","VIOL_FILE_UPLOAD_IN_BODY","VIOL_XML_MALFORMED","VIOL_JSON_MALFORMED","VIOL_ASM_COOKIE_MODIFIED","VIOL_HTTP_PROTOCOL_MULTIPLE_HOST_HEADERS","VIOL_HTTP_PROTOCOL_BAD_HOST_HEADER_VALUE","VIOL_HTTP_PROTOCOL_UNPARSABLE_REQUEST_CONTENT","VIOL_HTTP_PROTOCOL_NULL_IN_REQUEST","VIOL_HTTP_PROTOCOL_BAD_HTTP_VERSION","VIOL_HTTP_PROTOCOL_CRLF_CHARACTERS_BEFORE_REQUEST_START","VIOL_HTTP_PROTOCOL_NO_HOST_HEADER_IN_HTTP_1_1_REQUEST","VIOL_HTTP_PROTOCOL_BAD_MULTIPART_PARAMETERS_PARSING","VIOL_HTTP_PROTOCOL_SEVERAL_CONTENT_LENGTH_HEADERS","VIOL_HTTP_PROTOCOL_CONTENT_LENGTH_SHOULD_BE_A_POSITIVE_NUMBER","VIOL_EVASION_DIRECTORY_TRAVERSALS","VIOL_MALFORMED_REQUEST","VIOL_EVASION_MULTIPLE_DECODING","VIOL_DATA_GUARD","VIOL_EVASION_APACHE_WHITESPACE","VIOL_COOKIE_MODIFIED","VIOL_EVASION_IIS_UNICODE_CODEPOINTS","VIOL_EVASION_IIS_BACKSLASHES","VIOL_EVASION_PERCENT_U_DECODING","VIOL_EVASION_BARE_BYTE_DECODING","VIOL_EVASION_BAD_UNESCAPE","VIOL_HTTP_PROTOCOL_BAD_MULTIPART_FORMDATA_REQUEST_PARSING","VIOL_HTTP_PROTOCOL_BODY_IN_GET_OR_HEAD_REQUEST","VIOL_HTTP_PROTOCOL_HIGH_ASCII_CHARACTERS_IN_HEADERS","VIOL_ENCODING","VIOL_COOKIE_MALFORMED","VIOL_GRAPHQL_FORMAT","VIOL_GRAPHQL_MALFORMED","VIOL_GRAPHQL_INTROSPECTION_QUERY"],"default":"VIOL_NONE","x-displayname":"App Firewall Violation Type","x-ves-proto-enum":"ves.io.schema.app_firewall.AppFirewallViolationType"},"ioschemaEmpty":{"type":"object","description":"This can be used for messages where no values are needed","title":"Empty","x-displayname":"Empty","x-ves-proto-message":"ves.io.schema.Empty"},"ioschemaObjectRefType":{"type":"object","description":"This type establishes a 'direct reference' from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name for public API and Uid for private API\nThis type of reference is called direct because the relation is explicit and concrete (as opposed\nto selector reference which builds a group based on labels of selectee objects)","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.ObjectRefType","properties":{"kind":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then kind will hold the referred object's kind (e.g. \"route\")\n\nExample: ` \"virtual_site\"`","title":"kind","x-displayname":"Kind","x-ves-example":"virtual_site"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then uid will hold the referred object's(e.g. route's) uid.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"namespaceAPIItemListReq":{"type":"object","description":"A request API item list.","title":"APIItemListReq","x-displayname":"API Item List Req","x-ves-proto-message":"ves.io.schema.namespace.APIItemListReq","properties":{"items":{"type":"array","description":" A list of request API items.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 100\n","title":"items","maxItems":100,"items":{"$ref":"#/components/schemas/namespaceAPIItemReq"},"x-displayname":"Items","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"100"}},"list_id":{"type":"string","description":" API item list identifier\n\nExample: ` \"value\"`","title":"list_id","x-displayname":"List ID","x-ves-example":"value"}}},"namespaceAPIItemListResp":{"type":"object","description":"A response API item list.\nresult will show combined AND output from the result of individual api items.","title":"APIItemListResp","x-displayname":"API Item List Resp","x-ves-proto-message":"ves.io.schema.namespace.APIItemListResp","properties":{"items":{"type":"array","description":" A list of response API item lists.","title":"items","items":{"$ref":"#/components/schemas/namespaceAPIItemResp"},"x-displayname":"Items"},"list_id":{"type":"string","description":" API item list identifier\n\nExample: ` \"value\"`","title":"list_id","x-displayname":"List ID","x-ves-example":"value"},"result":{"type":"boolean","description":" Combined result after evaluation of items","title":"result","format":"boolean","x-displayname":"Result"}}},"namespaceAPIItemReq":{"type":"object","description":"A request API item.","title":"APIItemReq","x-displayname":"API Item Req","x-ves-proto-message":"ves.io.schema.namespace.APIItemReq","properties":{"method":{"type":"string","description":" HTTP request method\n\nExample: ` \"GET\"`","title":"method","x-displayname":"Method","x-ves-example":"GET"},"path":{"type":"string","description":" HTTP request URL path\n\nExample: ` \"/api/web/namespaces\"`","title":"path","x-displayname":"Path","x-ves-example":"/api/web/namespaces"}}},"namespaceAPIItemResp":{"type":"object","description":"A response API item.","title":"APIItemResp","x-displayname":"API Item Resp","x-ves-oneof-field-access_enablers":"[\"addon_services\",\"none\"]","x-ves-proto-message":"ves.io.schema.namespace.APIItemResp","properties":{"addon_services":{"$ref":"#/components/schemas/namespaceAccessEnablerAddonService"},"method":{"type":"string","description":" HTTP request method\n\nExample: ` \"GET\"`","title":"method","x-displayname":"Method","x-ves-example":"GET"},"none":{"$ref":"#/components/schemas/ioschemaEmpty"},"path":{"type":"string","description":" HTTP request URL path\n\nExample: ` \"/api/web/namespaces\"`","title":"path","x-displayname":"Path","x-ves-example":"/api/web/namespaces"},"result":{"type":"boolean","description":" Result after evaluation ","title":"result","format":"boolean","x-displayname":"Result"}}},"namespaceAccessControlType":{"type":"string","description":"Enum consists of different access control types.\n\n - RBAC: RBAC\n\nDefault access control, evaluates role based access control.\n - PBAC: PBAC\n\nEvaluates plan based access control\n - ALL: ALL\n\nEvaluates all access controls specified in this enum.","title":"AccessControlType","enum":["RBAC","PBAC","ALL"],"default":"RBAC","x-displayname":"Access Control Type","x-ves-proto-enum":"ves.io.schema.namespace.AccessControlType"},"namespaceAccessEnablerAddonService":{"type":"object","description":"An addon service details schema","title":"AccessEnablerAddonService","x-displayname":"Access Enabler Addon Service","x-ves-proto-message":"ves.io.schema.namespace.AccessEnablerAddonService","properties":{"addon_service_names":{"type":"array","description":" List of addon service names.","title":"addon_service_names","items":{"type":"string"},"x-displayname":"Addon Service Names"}}},"namespaceAllApplicationInventoryRequest":{"type":"object","description":"Request for inventory of application related objects","title":"AllApplicationInventoryRequest","x-displayname":"All Application related objects inventory request","x-ves-proto-message":"ves.io.schema.namespace.AllApplicationInventoryRequest","properties":{"bigip_virtual_server_filter":{"$ref":"#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType"},"cdn_load_balancer_filter":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"},"http_load_balancer_filter":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"},"nginx_one_server_filter":{"$ref":"#/components/schemas/namespaceNGINXOneServerInventoryFilterType"},"tcp_load_balancer_filter":{"$ref":"#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType"},"third_party_application_filter":{"$ref":"#/components/schemas/namespaceThirdPartyApplicationFilterType"},"udp_load_balancer_filter":{"$ref":"#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType"}}},"namespaceAllApplicationInventoryWafFilterRequest":{"type":"object","description":"Request for inventory of application related objects with WAF Filter","title":"AllApplicationInventoryWafFilterRequest","x-displayname":"All Application related objects inventory request with WAF Filter","x-ves-oneof-field-waf_filter_choice":"[\"exclusion_signature_id\",\"exclusion_violation_type\"]","x-ves-proto-message":"ves.io.schema.namespace.AllApplicationInventoryWafFilterRequest","properties":{"exclusion_signature_id":{"type":"integer","description":"Exclusive with [exclusion_violation_type]\n","title":"WAF Exclusion Rule Signature Id","format":"int64","x-displayname":"WAF Exclusion Rule Signature Id"},"exclusion_violation_type":{"$ref":"#/components/schemas/app_firewallAppFirewallViolationType"}}},"namespaceAllApplicationInventoryWafFilterResponse":{"type":"object","description":"Response for inventory of application related objects","title":"AllApplicationInventoryWafFilterResponse","x-displayname":"Application related objects inventory response","x-ves-proto-message":"ves.io.schema.namespace.AllApplicationInventoryWafFilterResponse","properties":{"cdn_loadbalancers":{"type":"array","description":" Application Inventory of configured CDN Loadbalancers with WAF Filters","title":"CDN Loadbalancer Inventory with WAF Filters","items":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerWafFilterResultType"},"x-displayname":"CDN Loadbalancers with WAF Filters"},"http_loadbalancers":{"type":"array","description":" Application Inventory of configured HTTP Loadbalancers with WAF Filters","title":"HTTP Loadbalancer Inventory with WAF Filters","items":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerWafFilterResultType"},"x-displayname":"HTTP Loadbalancers with WAF Filters"}}},"namespaceApiEndpointsStatsAllNSReq":{"type":"object","description":"Request shape for GET Api Endpoints Stats All Namespaces","title":"Api Endpoints stats all namespaces request","x-displayname":"Api Endpoints Stats All Namespaces Request","x-ves-proto-message":"ves.io.schema.namespace.ApiEndpointsStatsAllNSReq","properties":{"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"}}},"namespaceApiEndpointsStatsNSReq":{"type":"object","description":"Request shape for GET Api Endpoints Stats","title":"Api Endpoints stats request","x-displayname":"Api Endpoints Stats Request","x-ves-proto-message":"ves.io.schema.namespace.ApiEndpointsStatsNSReq","properties":{"namespace":{"type":"string","description":" Namespace of the App type for current request\n\nExample: ` \"shared\"`","title":"Namespace","x-displayname":"Namespace","x-ves-example":"shared"},"vhosts_filter":{"type":"array","description":" List of Virtual Hosts for current request\n If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.\n\nExample: ` \"blogging-app, test-app\"`","title":"List Of Virtual Hosts Name","items":{"type":"string"},"x-displayname":"List Of Virtual Hosts Name","x-ves-example":"blogging-app, test-app"},"vhosts_types_filter":{"type":"array","description":" List of Virtual Hosts types for current request\n If the list is empty or not provided, it will return stats for all virtual hosts under the requested namespace.\n\nExample: ` [\"HTTP_LOAD_BALANCER\", \"CDN_LOAD_BALANCER\"]`\n\nValidation Rules:\n  ves.io.schema.rules.enum.in: [1,6,7,8]\n  ves.io.schema.rules.repeated.unique: true\n","title":"Virtual Hosts Types Filter","items":{"$ref":"#/components/schemas/virtual_hostVirtualHostType"},"x-displayname":"Virtual Hosts Types Filter","x-ves-validation-rules":{"ves.io.schema.rules.enum.in":"[1,6,7,8]","ves.io.schema.rules.repeated.unique":"true"}}}},"namespaceApiEndpointsStatsNSRsp":{"type":"object","description":"Response shape for GET API endpoints Stats.","title":"Api Endpoints stats Response","x-displayname":"Api Endpoints Stats Response","x-ves-proto-message":"ves.io.schema.namespace.ApiEndpointsStatsNSRsp","properties":{"discovered":{"type":"integer","description":" number of endpoints that categorized as discover","title":"number of discovered endpoints","format":"int32","x-displayname":"Discovered"},"inventory":{"type":"integer","description":" number of endpoints that categorized as inventory","title":"number of inventory endpoints","format":"int32","x-displayname":"Inventory"},"pii_detected":{"type":"integer","description":"number of endpoints that detected with pii","title":"number of pii endpoints","format":"int32","x-displayname":"PII Detected"},"shadow":{"type":"integer","description":" number of endpoints that categorized as shadow","title":"number of shadow endpoints","format":"int32","x-displayname":"Shadow"},"total_endpoints":{"type":"integer","description":" total endpoints","title":"number of endpoints","format":"int32","x-displayname":"Total Endpoints"}}},"namespaceApplicationInventoryRequest":{"type":"object","description":"Request for inventory of application related objects from all namespaces","title":"ApplicationInventoryRequest","x-displayname":"Application related objects inventory request","x-ves-proto-message":"ves.io.schema.namespace.ApplicationInventoryRequest","properties":{"bigip_virtual_server_filter":{"$ref":"#/components/schemas/namespaceBIGIPVirtualServerInventoryFilterType"},"cdn_load_balancer_filter":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"},"http_load_balancer_filter":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryFilterType"},"namespace":{"type":"string","description":" The name of the namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"nginx_one_server_filter":{"$ref":"#/components/schemas/namespaceNGINXOneServerInventoryFilterType"},"tcp_load_balancer_filter":{"$ref":"#/components/schemas/namespaceTCPLoadbalancerInventoryFilterType"},"third_party_application_filter":{"$ref":"#/components/schemas/namespaceThirdPartyApplicationFilterType"},"udp_load_balancer_filter":{"$ref":"#/components/schemas/namespaceUDPLoadbalancerInventoryFilterType"}}},"namespaceApplicationInventoryResponse":{"type":"object","description":"Response for inventory of application related objects","title":"ApplicationInventoryResponse","x-displayname":"Application related objects inventory response","x-ves-proto-message":"ves.io.schema.namespace.ApplicationInventoryResponse","properties":{"bigip_virtual_servers":{"$ref":"#/components/schemas/namespaceBIGIPVirtualServerInventoryType"},"cdn_loadbalancers":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryType"},"http_loadbalancers":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerInventoryType"},"loadbalancers":{"type":"integer","description":" Number of HTTP and TCP Load Balancers configured","title":"Load Balancers","format":"int64","x-displayname":"Load Balancers"},"nginx_one_servers":{"$ref":"#/components/schemas/namespaceNGINXOneServerInventoryType"},"origin_pools":{"type":"integer","description":" Number of origin pools configured","title":"Origin Pools","format":"int64","x-displayname":"Origin Pools"},"services_discovered":{"type":"integer","description":" Number of services discovered","title":"Services Discovered","format":"int64","x-displayname":"Services Discovered"},"tcp_loadbalancers":{"$ref":"#/components/schemas/namespaceTCPLoadbalancerInventoryType"},"third_party_applications":{"$ref":"#/components/schemas/namespaceThirdPartyApplicationInventoryType"},"udp_loadbalancers":{"$ref":"#/components/schemas/namespaceUDPLoadbalancerInventoryType"}}},"namespaceBIGIPVirtualServerInventoryFilterType":{"type":"object","description":"BIGIP Virtual Server Inventory Filter","title":"BIGIPVirtualServerInventoryFilterType","x-displayname":"Filter for BIG-IP Virtual Server Inventory","x-ves-proto-message":"ves.io.schema.namespace.BIGIPVirtualServerInventoryFilterType","properties":{"api_discovery":{"type":"boolean","description":" Filter results with BIGIP Virtual Server with API Discovery","title":"API Discovery","format":"boolean","x-displayname":"API Discovery"},"waf_configured":{"type":"boolean","description":" Filter results with BIGIP Virtual Server with WAF configured","title":"WAF","format":"boolean","x-displayname":"WAF"}}},"namespaceBIGIPVirtualServerInventoryType":{"type":"object","description":"BIGIP Virtual Server inventory","title":"BIGIPVirtualServerInventoryType","x-displayname":"Inventory of BIG-IP Virtual Server","x-ves-proto-message":"ves.io.schema.namespace.BIGIPVirtualServerInventoryType","properties":{"api_discovery":{"type":"integer","description":" Number of BIGIP Virtual Servers with API Discovery enabled","title":"API Discovery","format":"int64","x-displayname":"API Discovery"},"bigiplb_results":{"type":"array","description":" List of BIGIP Virtual Server","title":"BIGIP Virtual Server","items":{"$ref":"#/components/schemas/namespaceBIGIPVirtualServerResultType"},"x-displayname":"List of BIG-IP Virtual Server"},"waf_configured":{"type":"integer","description":" Number of BIGIP Virtual Servers with WAF configured","title":"WAF","format":"int64","x-displayname":"WAF"}}},"namespaceBIGIPVirtualServerResultType":{"type":"object","description":"BIGIP Virtual Server Inventory Results","title":"BIGIPVirtualServerResultType","x-displayname":"BIG-IP Virtual Server Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.BIGIPVirtualServerResultType","properties":{"api_discovery_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"description":{"type":"string","description":" VS Description of BIGIP","title":"BIGIP VS Description","x-displayname":"BIG-IP VS Description"},"host_name":{"type":"string","description":" Name of BIGIP Host","title":"BIGIP Host Name","x-displayname":"BIG-IP Host Name"},"name":{"type":"string","description":" Name of BIGIP Virtual Server","title":"BIGIP Virtual Server Name","x-displayname":"BIG-IP Virtual Server Name"},"server_name":{"type":"string","description":" Display Name of BIGIP VS","title":"BIGIP VS Display Name","x-displayname":"BIG-IP VS Server Name"},"version":{"type":"string","description":" Version of BIGIP","title":"BIGIP Version","x-displayname":"BIG-IP Version"},"waf_enforcement_mode":{"type":"string","description":" WAF Enforcement Mode","title":"WAF Enforcement Mode","x-displayname":"WAF Enforcement Mode"},"waf_policy_name":{"type":"string","description":" WAF Policy Name","title":"WAF Policy Name","x-displayname":"WAF Policy Name"}}},"namespaceCascadeDeleteItemType":{"type":"object","description":"CascadeDeleteItemType is details of object that was handled as part of cascade delete\nof namespace and whether it was successfully deleted","title":"CascadeDeleteItemType","x-displayname":"Cascade Delete Item","x-ves-proto-message":"ves.io.schema.namespace.CascadeDeleteItemType","properties":{"error_message":{"type":"string","description":" A description of the error encountered (if any) in the process of cascade deletion\n\nExample: ` \"value\"`","title":"error_message","x-displayname":"Error","x-ves-example":"value"},"object_name":{"type":"string","description":" Name of the configuration object that was deleted\n\nExample: ` \"value\"`","title":"object_name","x-displayname":"Name","x-ves-example":"value"},"object_type":{"type":"string","description":" The type of the contained configuration object in the namespace that was deleted\n\nExample: ` \"ves.io.schema.virtual_host.Object\"`","title":"object_type","x-displayname":"Type","x-ves-example":"ves.io.schema.virtual_host.Object"},"object_uid":{"type":"string","description":" The UID identifier of the configuration object that was deleted\n\nExample: ` \"value\"`","title":"object_uid","x-displayname":"UID","x-ves-example":"value"}}},"namespaceCascadeDeleteRequest":{"type":"object","description":"CascadeDeleteRequest contains the name of the namespace that has to be deleted\nalong with the objects configured under the namespace","title":"CascadeDeleteRequest","x-displayname":"Cascade Delete Request","x-ves-proto-message":"ves.io.schema.namespace.CascadeDeleteRequest","properties":{"name":{"type":"string","description":" The name of the namespace\n\nExample: ` \"value\"`","title":"name","x-displayname":"Name","x-ves-example":"value"}}},"namespaceCascadeDeleteResponse":{"type":"object","description":"CascadeDeleteResponse contains a list of objects in the namespace that were\ndeleted (or encountered an error while deleting)","title":"CascadeDeleteResponse","x-displayname":"Cascade Delete Response","x-ves-proto-message":"ves.io.schema.namespace.CascadeDeleteResponse","properties":{"items":{"type":"array","description":" The objects deleted in namespace","title":"items","items":{"$ref":"#/components/schemas/namespaceCascadeDeleteItemType"},"x-displayname":"Items"}}},"namespaceCreateRequest":{"type":"object","description":"This is the input message of the 'Create' RPC","title":"CreateRequest is used to create an instance of namespace","x-displayname":"Create Request","x-ves-proto-message":"ves.io.schema.namespace.CreateRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectCreateMetaType"},"spec":{"$ref":"#/components/schemas/schemanamespaceCreateSpecType"}}},"namespaceCreateResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.namespace.CreateResponse","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"spec":{"$ref":"#/components/schemas/schemanamespaceGetSpecType"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"namespaceEvaluateAPIAccessReq":{"type":"object","description":"Request body of Evaluate API Access","title":"EvaluateAPIAccessReq","x-displayname":"Evaluate API Access Req","x-ves-proto-message":"ves.io.schema.namespace.EvaluateAPIAccessReq","properties":{"access_control_type":{"$ref":"#/components/schemas/namespaceAccessControlType"},"item_lists":{"type":"array","description":" A list of request API item lists.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1000\n","title":"item_lists","maxItems":1000,"items":{"$ref":"#/components/schemas/namespaceAPIItemListReq"},"x-displayname":"Item Lists","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1000"}},"namespace":{"type":"string","description":" Name of the namespace under which all the URLs in APIItems will be evaluated\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"namespaceEvaluateAPIAccessResp":{"type":"object","description":"Response body of Evaluate API Access","title":"EvaluateAPIAccessResp","x-displayname":"Response for EvaluateAPIAccess","x-ves-proto-message":"ves.io.schema.namespace.EvaluateAPIAccessResp","properties":{"item_lists":{"type":"array","description":" A list of request API item lists.","title":"item_lists","items":{"$ref":"#/components/schemas/namespaceAPIItemListResp"},"x-displayname":"Item Lists"}}},"namespaceEvaluateBatchAPIAccessReq":{"type":"object","description":"Request body of Evaluate Batch API Access","title":"EvaluateBatchAPIAccessReq","x-displayname":"Evaluate Batch API Access Req","x-ves-proto-message":"ves.io.schema.namespace.EvaluateBatchAPIAccessReq","properties":{"batch_namespace_api_list":{"type":"array","description":" List of namespaces and associated api list entries\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 75\n","title":"batch_namespace_api_list","maxItems":75,"items":{"$ref":"#/components/schemas/namespaceNamespaceAPIListReq"},"x-displayname":"Batch Namespace Api List","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"75"}}}},"namespaceEvaluateBatchAPIAccessResp":{"type":"object","description":"Response body of Evaluate Batch API Access","title":"EvaluateBatchAPIAccessResp","x-displayname":"Evaluate Batch API Access Resp","x-ves-proto-message":"ves.io.schema.namespace.EvaluateBatchAPIAccessResp","properties":{"batch_namespace_api_list":{"type":"array","description":" List of namespaces and associated api list entries","title":"batch_namespace_api_list","items":{"$ref":"#/components/schemas/namespaceNamespaceAPIListResp"},"x-displayname":"Batch Namespace Api List"}}},"namespaceGetActiveAlertPoliciesResponse":{"type":"object","description":"GetActiveAlertPoliciesResponse is the shape of the response for GetActiveAlertPolicies.","title":"GetActiveAlertPoliciesResponse","x-displayname":"Response for GetActiveAlertPolicies","x-ves-proto-message":"ves.io.schema.namespace.GetActiveAlertPoliciesResponse","properties":{"alert_policies":{"type":"array","description":" A list of references to alert_policy objects.","title":"alert_policies","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Alert Policies"},"alert_policies_status":{"type":"array","description":" The status of alert policies","title":"policy_status","items":{"$ref":"#/components/schemas/alert_policy_setAlertPolicyStatus"},"x-displayname":"Alert Policies Status"}}},"namespaceGetActiveNetworkPoliciesResponse":{"type":"object","description":"GetActiveNetworkPoliciesResponse is the shape of the response for GetActiveNetworkPolicies.","title":"GetActiveNetworkPoliciesResponse","x-displayname":"Response for GetActiveNetworkPolicies","x-ves-proto-message":"ves.io.schema.namespace.GetActiveNetworkPoliciesResponse","properties":{"network_policies":{"type":"array","description":" A list of references to network_policy objects.","title":"network_policies","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Network Policies"}}},"namespaceGetActiveServicePoliciesResponse":{"type":"object","description":"GetActiveServicePoliciesResponse is the shape of the response for GetActiveServicePolicies.","title":"GetActiveServicePoliciesResponse","x-displayname":"Response for GetActiveServicePolicies","x-ves-proto-message":"ves.io.schema.namespace.GetActiveServicePoliciesResponse","properties":{"service_policies":{"type":"array","description":" A list of references to service_policy objects.","title":"service_policies","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Service Policies"}}},"namespaceGetFastACLsForInternetVIPsResponse":{"type":"object","description":"GetFastACLsForInternetVIPsResponse contains list of FastACLs refs that\nare applied to the Internet VIPs","title":"GetFastACLsForInternetVIPsResponse","x-displayname":"Response for GetFastACLsForInternetVIPs","x-ves-proto-message":"ves.io.schema.namespace.GetFastACLsForInternetVIPsResponse","properties":{"fast_acls":{"type":"array","description":" The list of refs of FastACLs\n\nExample: ` \"list of refs\"`","title":"fast_acls","items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"FastACLs","x-ves-example":"list of refs"}}},"namespaceGetResponse":{"type":"object","description":"This is the output message of the 'Get' RPC","title":"GetResponse is the shape of a read namespace","x-displayname":"Get Response","x-ves-proto-message":"ves.io.schema.namespace.GetResponse","properties":{"create_form":{"$ref":"#/components/schemas/namespaceCreateRequest"},"deleted_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"deleted_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Deleted Referred Objects"},"disabled_referred_objects":{"type":"array","description":"The set of deleted objects that are referred by this object","title":"disabled_referred_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Disabled Referred Objects"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"referring_objects":{"type":"array","description":"The set of objects that are referring to this object in their spec","title":"referring_objects","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Referring Objects"},"replace_form":{"$ref":"#/components/schemas/namespaceReplaceRequest"},"spec":{"$ref":"#/components/schemas/schemanamespaceGetSpecType"},"status":{"type":"array","description":"The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/schemanamespaceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"}}},"namespaceGetResponseFormatCode":{"type":"string","description":"x-displayName: \"Get Response Format\"\nThis is the various forms that can be requested to be sent in the GetResponse\n\n - GET_RSP_FORMAT_DEFAULT: x-displayName: \"Default Format\"\nDefault format of returned resource\n - GET_RSP_FORMAT_FOR_CREATE: x-displayName: \"Create request Format\"\nResponse should be in CreateRequest format\n - GET_RSP_FORMAT_FOR_REPLACE: x-displayName: \"Replace request format\"\nResponse should be in ReplaceRequest format\n - GET_RSP_FORMAT_STATUS: x-displayName: \"Status format\"\nResponse should be in StatusObject(s) format\n - GET_RSP_FORMAT_READ: x-displayName: \"GetSpecType format\"\nResponse should be in format of GetSpecType\n - GET_RSP_FORMAT_REFERRING_OBJECTS: x-displayName: \"Referring Objects\"\nResponse should have other objects referring to this object\n - GET_RSP_FORMAT_BROKEN_REFERENCES: x-displayName: \"Broken Referred Objects\"\nResponse should have deleted and disabled objects referrred by this object","title":"GetResponseFormatCode","enum":["GET_RSP_FORMAT_DEFAULT","GET_RSP_FORMAT_FOR_CREATE","GET_RSP_FORMAT_FOR_REPLACE","GET_RSP_FORMAT_STATUS","GET_RSP_FORMAT_READ","GET_RSP_FORMAT_REFERRING_OBJECTS","GET_RSP_FORMAT_BROKEN_REFERENCES"],"default":"GET_RSP_FORMAT_DEFAULT"},"namespaceHTTPLoadbalancerInventoryFilterType":{"type":"object","description":"HTTP Loadbalancer Inventory Filter","title":"HTTPLoadbalancerInventoryFilterType","x-displayname":"Filter for HTTP Loadbalancers Inventory","x-ves-proto-message":"ves.io.schema.namespace.HTTPLoadbalancerInventoryFilterType","properties":{"api_definition":{"type":"boolean","description":" Filter results with HTTP loadbalancers with API Definition","title":"API Definition","format":"boolean","x-displayname":"API Definition"},"api_discovery":{"type":"boolean","description":" Filter results with HTTP loadbalancers with API Discovery","title":"API Discovery","format":"boolean","x-displayname":"API Discovery"},"api_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with API Protection configured","title":"API Protection","format":"boolean","x-displayname":"API Protection"},"api_schema_validation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with API Schema Validation","title":"API Schema Validation","format":"boolean","x-displayname":"API Schema Validation"},"bot_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Bot Protection configured","title":"Bot Protection","format":"boolean","x-displayname":"Bot Protection"},"client_blocking":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Client Blocking","title":"Client Blocking","format":"boolean","x-displayname":"Client Blocking"},"client_side_defense":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Client Side Defense configured","title":"Client Side Defense","format":"boolean","x-displayname":"Client Side Defense"},"cookie_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Cookie Protection","title":"Cookie Protection","format":"boolean","x-displayname":"Cookie Protection"},"cors_policy":{"type":"boolean","description":" Filter results with HTTP loadbalancers with CORS Policy","title":"CORS Policy","format":"boolean","x-displayname":"CORS Policy"},"csrf_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with CSRF Protection","title":"CSRF Protection","format":"boolean","x-displayname":"CSRF Protection"},"data_guard":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Data Guard","title":"Data Guard","format":"boolean","x-displayname":"Data Guard"},"ddos_auto_mitigation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with L7 DDoS Auto Mitigation enabled","title":"L7 DDoS Auto Mitigation","format":"boolean","x-displayname":"L7 DDoS Auto Mitigation"},"ddos_mitigation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with DDoS Mitigation Rules configured","title":"DDoS Mitigation Rules","format":"boolean","x-displayname":"DDoS Mitigation Rules"},"ddos_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with L7 DDoS detection enabled","title":"L7 DDoS Detection","format":"boolean","x-displayname":"L7 DDoS Detection"},"default_loadbalancer":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Default Loadbalancer","title":"Default Loadbalancer","format":"boolean","x-displayname":"Default Loadbalancer"},"graph_ql_inspection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with GraphQL Inspection","title":"GraphQL Inspection","format":"boolean","x-displayname":"GraphQL Inspection"},"http_only":{"type":"boolean","description":" Filter results with HTTP only loadbalancers","title":"HTTP Only","format":"boolean","x-displayname":"HTTP Only"},"ip_reputation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with IP Reputation configured","title":"IP Reputation","format":"boolean","x-displayname":"IP Reputation"},"malicious_user_detection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Malicious User Detection configured","title":"Malicious User Detection","format":"boolean","x-displayname":"Malicious User Detection"},"malicious_user_mitigation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Malicious User Mitigation","title":"Malicious User Mitigation","format":"boolean","x-displayname":"Malicious User Mitigation"},"malware_protection":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Malware Protection","title":"Malware Protection","format":"boolean","x-displayname":"Malware Protection"},"mutual_tls":{"type":"boolean","description":" Filter results with HTTP loadbalancers with mTLS","title":"mTLS","format":"boolean","x-displayname":"mTLS"},"namespace_service_policy":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Namespace Service Policy configured","title":"Namespace Service Policy","format":"boolean","x-displayname":"Namespace Service Policy"},"origin_server_subset":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Origin Server Subset","title":"Origin Server Subset","format":"boolean","x-displayname":"Origin Server Subset"},"private_advertisement":{"type":"boolean","description":" Filter results with HTTP loadbalancers advertised privately","title":"Private Advertisement","format":"boolean","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"boolean","description":" Filter results with HTTP loadbalancers advertised publicly","title":"Public Advertisement","format":"boolean","x-displayname":"Public Advertisement"},"routes":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Routes","title":"Routes","format":"boolean","x-displayname":"Routes"},"service_policy":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Service Policy configured","title":"Service Policy","format":"boolean","x-displayname":"Service Policy"},"slow_ddos_mitigation":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Slow DDoS Mitigation","title":"Slow DDoS Mitigation","format":"boolean","x-displayname":"Slow DDoS Mitigation"},"trusted_client":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Trusted Client","title":"Trusted Client","format":"boolean","x-displayname":"Trusted Client"},"trusted_client_ip_headers":{"type":"boolean","description":" Filter results with HTTP loadbalancers with Trusted Client IP Headers","title":"Trusted Client IP Headers","format":"boolean","x-displayname":"Trusted Client IP Headers"},"waf":{"type":"boolean","description":" Filter results with HTTP loadbalancers with WAF configured","title":"WAF","format":"boolean","x-displayname":"WAF"},"waf_exclusion":{"type":"boolean","description":" Filter results with HTTP loadbalancers with WAF Exclusion","title":"WAF Exclusion","format":"boolean","x-displayname":"WAF Exclusion"}}},"namespaceHTTPLoadbalancerInventoryType":{"type":"object","description":"HTTP Loadbalancer inventory","title":"HTTPLoadbalancerInventoryType","x-displayname":"Inventory of HTTP Loadbalancers","x-ves-proto-message":"ves.io.schema.namespace.HTTPLoadbalancerInventoryType","properties":{"api_discovery":{"type":"integer","description":" Number of HTTP loadbalancers with API Discovery enabled","title":"API Discovery","format":"int64","x-displayname":"API Discovery"},"api_protection":{"type":"integer","description":" Number of HTTP loadbalancers with API Protection configured","title":"API Protection","format":"int64","x-displayname":"API Protection"},"bot_protection":{"type":"integer","description":" Number of HTTP loadbalancers with Bot Protection configured","title":"Bot Protection","format":"int64","x-displayname":"Bot Protection"},"cdnlb_results":{"type":"array","description":" List of CDN loadbalancers","title":"CDN Loadbalancers","items":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerResultType"},"x-displayname":"List of CDN Loadbalancers"},"client_side_defense":{"type":"integer","description":" Number of HTTP loadbalancers with Client Side Defense configured","title":"Client Side Defense","format":"int64","x-displayname":"Client Side Defense"},"ddos_protection":{"type":"integer","description":" Number of HTTP loadbalancers with L7 DDoS Detection enabled","title":"L7 DDoS Detection","format":"int64","x-displayname":"L7 DDoS Detection"},"http_only":{"type":"integer","description":" Number of HTTP Only loadbalancers","title":"HTTP Only","format":"int64","x-displayname":"HTTP Only"},"httplb_results":{"type":"array","description":" List of HTTP loadbalancers","title":"HTTP Loadbalancers","items":{"$ref":"#/components/schemas/namespaceHTTPLoadbalancerResultType"},"x-displayname":"List of HTTP Loadbalancers"},"ip_reputation":{"type":"integer","description":" Number of HTTP loadbalancers with IP Reputation configured","title":"IP Reputation","format":"int64","x-displayname":"IP Reputation"},"malicious_user_detection":{"type":"integer","description":" Number of HTTP loadbalancers with Malicious User Detection configured","title":"Malicious User Detection","format":"int64","x-displayname":"Malicious User Detection"},"malware_protection":{"type":"integer","description":" Number of HTTP loadbalancers with Malware Protection configured","title":"Malware Protection","format":"int64","x-displayname":"Malware Protection"},"namespace_service_policy":{"type":"integer","description":" Number of HTTP loadbalancers with Namespace Service Policy configured","title":"Namespace Service Policy","format":"int64","x-displayname":"Namespace Service Policy"},"private_advertisement":{"type":"integer","description":" Number of HTTP loadbalancers advertised privately","title":"Private Advertisement","format":"int64","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"integer","description":" Number of HTTP loadbalancers advertised publicly","title":"Public Advertisement","format":"int64","x-displayname":"Public Advertisement"},"service_policy":{"type":"integer","description":" Number of HTTP loadbalancers with Service Policy configured","title":"Service Policy","format":"int64","x-displayname":"Service Policy"},"waf":{"type":"integer","description":" Number of HTTP loadbalancers with WAF configured","title":"WAF","format":"int64","x-displayname":"WAF"}}},"namespaceHTTPLoadbalancerResultType":{"type":"object","description":"HTTP Loadbalancer Inventory Results","title":"HTTPLoadbalancerResultType","x-displayname":"HTTP Loadbalancer Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.HTTPLoadbalancerResultType","properties":{"api_definition_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"api_discovery_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"api_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"api_schema_validation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"bot_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"certification_expiration_date":{"type":"string","description":" Certification Expiration Date","title":"Certification Expiration Date","format":"date-time","x-displayname":"Certification Expiration Date"},"certification_status":{"type":"string","description":" Certification Status","title":"Certification Status","x-displayname":"Certification Status"},"client_blocking_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"client_side_defense_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"connection_idle_timeout":{"type":"integer","description":" Connection Idle Timeout","title":"Connection Idle Timeout","format":"int64","x-displayname":"Connection Idle Timeout"},"cookie_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"cors_policy_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"csrf_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"data_guard_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"ddos_auto_mitigation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"ddos_mitigation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"ddos_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"default_loadbalancer_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"dns_info":{"type":"string","description":" DNS Info","title":"DNS Info","x-displayname":"DNS Info"},"domains":{"type":"array","description":" Domains ","title":"Domains","items":{"type":"string"},"x-displayname":"Domains"},"graph_ql_inspection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"http_listen_port_choice":{"type":"string","description":" HTTP Listen Port Choice ","title":"HTTP Listen Port Choice","x-displayname":"HTTP Listen Port Choice"},"idle_timeout":{"type":"integer","description":" Idle Timeout ","title":"Idle Timeout","format":"int64","x-displayname":"Idle Timeout"},"ip_reputation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"loadbalancer_algorithm":{"type":"string","description":" Loadbalancer Algorithm configured ","title":"Loadbalancer Algorithm","x-displayname":"Loadbalancer Algorithm"},"malicious_user_detection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"malicious_user_mitigation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"malware_protection_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"mutual_tls_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"name":{"type":"string","description":" Name of HTTP LB","title":"HTTP LB Name","x-displayname":"HTTP LB Name"},"namespace":{"type":"string","description":" Namespace of HTTP LB","title":"HTTP LB Namespace","x-displayname":"HTTP LB Namespace"},"namespace_service_policy_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"origin_server_subset_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"private_advertisement_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"public_advertisment_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"rate_limit":{"$ref":"#/components/schemas/ioschemaEmpty"},"routes_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"service_policy_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"slow_ddos_mitigation_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_security_level":{"type":"string","description":" TLS Security Level","title":"TLS Security Level","x-displayname":"TLS Security Level"},"trusted_client_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"trusted_client_ip_headers_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"vip_type":{"type":"string","description":" VIP Type ","title":"VIP Type","x-displayname":"VIP Type"},"waf_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"waf_enforcement_mode":{"type":"string","description":" WAF Enforcement Mode","title":"WAF Enforcement Mode","x-displayname":"WAF Enforcement Mode"},"waf_exclusion_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"waf_policy_ref":{"type":"array","description":" Reference to the WAF policy (if applicable)\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 1\n","title":"WAF Policy Reference","maxItems":1,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"WAF Policy Reference","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"1"}}}},"namespaceHTTPLoadbalancerWafFilterResultType":{"type":"object","description":"HTTP Loadbalancer Waf Filter Inventory Results","title":"HTTPLoadbalancerWafFilterResultType","x-displayname":"HTTP Loadbalancer Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.HTTPLoadbalancerWafFilterResultType","properties":{"name":{"type":"string","description":" Name of HTTP LB","title":"HTTP LB Name","x-displayname":"HTTP LB Name"},"namespace":{"type":"string","description":" Namespace of HTTP LB","title":"HTTP LB Namespace","x-displayname":"HTTP LB Namespace"}}},"namespaceListResponse":{"type":"object","description":"This is the output message of 'List' RPC.","title":"ListResponse is the collection of namespace","x-displayname":"List Response","x-ves-proto-message":"ves.io.schema.namespace.ListResponse","properties":{"errors":{"type":"array","description":" Errors(if any) while listing items from collection","title":"errors","items":{"$ref":"#/components/schemas/schemaErrorType"},"x-displayname":"Errors"},"items":{"type":"array","description":" items represents the collection in response","title":"items","items":{"$ref":"#/components/schemas/namespaceListResponseItem"},"x-displayname":"Items"}}},"namespaceListResponseItem":{"type":"object","description":"By default a summary of namespace is returned in 'List'. By setting\n'report_fields' in the ListRequest more details of each item can be got.","title":"ListResponseItem is an individual item in a collection of namespace","x-displayname":"List Item","x-ves-proto-message":"ves.io.schema.namespace.ListResponseItem","properties":{"annotations":{"type":"object","description":" The set of annotations present on this namespace","title":"annotations","x-displayname":"Annotations"},"description":{"type":"string","description":" The description set for this namespace","title":"description","x-displayname":"Description"},"disabled":{"type":"boolean","description":" A value of true indicates namespace is administratively disabled","title":"disabled","format":"boolean","x-displayname":"Disabled"},"get_spec":{"$ref":"#/components/schemas/schemanamespaceGetSpecType"},"labels":{"type":"object","description":" The set of labels present on this namespace","title":"labels","x-displayname":"Labels"},"metadata":{"$ref":"#/components/schemas/schemaObjectGetMetaType"},"name":{"type":"string","description":" The name of this namespace\n\nExample: ` \"name\"`","title":"name","x-displayname":"Name","x-ves-example":"name"},"namespace":{"type":"string","description":" The namespace this item belongs to\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"status_set":{"type":"array","description":" The status reported by different services for this configuration object","title":"status","items":{"$ref":"#/components/schemas/schemanamespaceStatusObject"},"x-displayname":"Status"},"system_metadata":{"$ref":"#/components/schemas/schemaSystemObjectGetMetaType"},"tenant":{"type":"string","description":" The tenant this item belongs to\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" The unique uid of this namespace\n\nExample: ` \"d27938ba-967e-40a7-9709-57b8627f9f75\"`","title":"uid","x-displayname":"UID","x-ves-example":"d27938ba-967e-40a7-9709-57b8627f9f75"}}},"namespaceLookupUserRolesReq":{"type":"object","description":"Request body of LookupUserRoles request","title":"LookupUserRolesReq","x-displayname":"Request for LookupUserRoles","x-ves-proto-message":"ves.io.schema.namespace.LookupUserRolesReq","properties":{"namespace":{"type":"string","description":" Name of the namespace to lookup user roles\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"namespaceLookupUserRolesResp":{"type":"object","description":"Response body of LookupUserRoles request","title":"LookupUserRolesResp","x-displayname":"Response for LookupUserRoles","x-ves-proto-message":"ves.io.schema.namespace.LookupUserRolesResp","properties":{"roles":{"type":"array","description":" List of user roles","title":"roles","items":{"type":"string"},"x-displayname":"Roles"}}},"namespaceNGINXOneServerInventoryFilterType":{"type":"object","description":"NGINX One Server Inventory Filter","title":"NGINXOneServerInventoryFilterType","x-displayname":"Filter for NGINX One Server Inventory","x-ves-proto-message":"ves.io.schema.namespace.NGINXOneServerInventoryFilterType","properties":{"api_discovery":{"type":"boolean","description":" Filter results with NGINX One Server with specificed API Discovery enablement state","title":"API Discovery","format":"boolean","x-displayname":"API Discovery"},"waf_configured":{"type":"boolean","description":" Filter results with NGINX One Server with specified WAF enablement state","title":"WAF","format":"boolean","x-displayname":"WAF"}}},"namespaceNGINXOneServerInventoryType":{"type":"object","description":"Inventory of configured NGINX One Servers","title":"NGINX One Server Inventory","x-displayname":"NGINX One Servers","x-ves-proto-message":"ves.io.schema.namespace.NGINXOneServerInventoryType","properties":{"api_discovery_enabled_server_count":{"type":"integer","description":" Number of NGINX One Servers with API Discovery enabled","title":"API Discovery","format":"int64","x-displayname":"API Discovery"},"nginx_server_results":{"type":"array","description":" List of NGINX One Server","title":"NGINX One Servers","items":{"$ref":"#/components/schemas/namespaceNGINXOneServerResultType"},"x-displayname":"List of NGINX One Server"},"waf_enabled_server_count":{"type":"integer","description":" Number of NGINX One Servers with WAF configured","title":"WAF","format":"int64","x-displayname":"WAF"}}},"namespaceNGINXOneServerResultType":{"type":"object","x-ves-proto-message":"ves.io.schema.namespace.NGINXOneServerResultType","properties":{"api_discovery_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"domains":{"type":"array","description":" Domains of Nginx One Server","title":"Nginx One Server Domains","items":{"type":"string"},"x-displayname":"Nginx One Server Domains"},"name":{"type":"string","description":" Uniqueness identifier for NGINX One Server","title":"Name","x-displayname":"Server Name"},"nginx_one_object_id":{"type":"string","description":" Instance or Config Sync Group ID","title":"NGINX One Object Id","x-displayname":"Instance or Config Sync Group Object ID"},"nginx_one_object_name":{"type":"string","description":" Hostname value set for Instance or Name for a Config Sync Group\n in NGINX One","title":"NGINX One Object Name","x-displayname":"Instance or Config Sync Group Name"},"nginx_one_server_name":{"type":"string","description":" Server name specified as ${server_name} in nginx config plus port","title":"Nginx One Server Name","x-displayname":"Name"},"total_routes":{"type":"integer","description":" Total locations configured in the NGINX Server","title":"Total locations configured in the NGINX Server","format":"int64","x-displayname":"Routes"},"waf_enforcement_mode":{"type":"string","description":" WAF Enforcement Mode","title":"WAF Enforcement Mode","x-displayname":"WAF Enforcement Mode"},"waf_policy_file_name":{"type":"string","description":" Policy file name for WAF","title":"Waf Policy File Names","x-displayname":"WAF Policy File Name"},"waf_policy_management_platform":{"type":"string","description":" Specifies the platform that manages related WAF policies\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"WAF policy_management_platform","x-displayname":"WAF Policy Management Platform","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"waf_policy_name":{"type":"string","description":" Policy name configured for WAF","title":"Waf Policy Name","x-displayname":"WAF Policy Name"},"waf_security_log_enabled":{"type":"boolean","description":" Specifies if security logging is enabled","title":"security_log_enabled","format":"boolean","x-displayname":"WAF Log Enabled"},"waf_security_log_file_names":{"type":"array","description":" WAF Security File Names","title":"WAF Security File Names","items":{"type":"string"},"x-displayname":"WAF Security File Names"}}},"namespaceNamespaceAPIListReq":{"type":"object","description":"NamespaceAPIListReq holds the namespace and its associated APIs","title":"NamespaceAPIListReq","x-displayname":"Namespace API List","x-ves-proto-message":"ves.io.schema.namespace.NamespaceAPIListReq","properties":{"item_lists":{"type":"array","description":" A list of request API item lists.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 15\n","title":"item_lists","maxItems":15,"items":{"$ref":"#/components/schemas/namespaceAPIItemListReq"},"x-displayname":"Item Lists","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"15"}},"namespace":{"type":"string","description":" Name of the namespace under which all the URLs in APIItems will be evaluated\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"namespaceNamespaceAPIListResp":{"type":"object","description":"NamespaceAPIListResp holds the namespace and its associated APIs","title":"NamespaceAPIListResp","x-displayname":"Namespace API List Resp","x-ves-proto-message":"ves.io.schema.namespace.NamespaceAPIListResp","properties":{"item_lists":{"type":"array","description":" A list of response API item lists.","title":"item_lists","items":{"$ref":"#/components/schemas/namespaceAPIItemListResp"},"x-displayname":"Item Lists"},"namespace":{"type":"string","description":" Name of the namespace under which all the URLs in item lists were evaluated\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"namespaceNetworkingInventoryRequest":{"type":"object","description":"Request for inventory of networking related objects","title":"NetworkingInventoryRequest","x-displayname":"Networking related objects inventory request","x-ves-proto-message":"ves.io.schema.namespace.NetworkingInventoryRequest"},"namespaceNetworkingInventoryResponse":{"type":"object","description":"Response for inventory of networking related objects","title":"NetworkingInventoryResponse","x-displayname":"Networking related objects inventory response","x-ves-proto-message":"ves.io.schema.namespace.NetworkingInventoryResponse","properties":{"cloud_links":{"type":"integer","description":" Number of CloudLinks","title":"CloudLinks","format":"int64","x-displayname":"CloudLinks"},"dc_cluster_groups":{"type":"integer","description":" Number of DC cluster groups configured","title":"DC Cluster Groups","format":"int64","x-displayname":"DC Cluster Groups"},"global_networks":{"type":"integer","description":" Number of global networks configured","title":"Global Networks","format":"int64","x-displayname":"Global Networks"},"segments":{"type":"integer","description":" Number of Segments","title":"Segments","format":"int64","x-displayname":"Segments"},"site_mesh_groups":{"type":"integer","description":" Number of site mesh groups configured","title":"Site Mesh Groups","format":"int64","x-displayname":"Site Mesh Groups"},"sites":{"type":"integer","description":" Number of sites configured","title":"Sites","format":"int64","x-displayname":"Sites"}}},"namespacePublicAdvertiseChoice":{"type":"string","description":"Enum for advertisement choise on public.\n\nInherit tenant's default.\nEnable enables advertisement on public.\nDisable disables advertisement on public.","title":"PublicAdvertiseChoice","enum":["Default","Enable","Disable"],"default":"Default","x-displayname":"PublicAdvertiseChoice","x-ves-proto-enum":"ves.io.schema.namespace.PublicAdvertiseChoice"},"namespaceReplaceRequest":{"type":"object","description":"This is the input message of the 'Replace' RPC","title":"ReplaceRequest is used to replace contents of a namespace","x-displayname":"Replace Request","x-ves-proto-message":"ves.io.schema.namespace.ReplaceRequest","properties":{"metadata":{"$ref":"#/components/schemas/schemaObjectReplaceMetaType"},"spec":{"$ref":"#/components/schemas/schemanamespaceReplaceSpecType"}}},"namespaceReplaceResponse":{"type":"object","x-ves-proto-message":"ves.io.schema.namespace.ReplaceResponse"},"namespaceSetActiveAlertPoliciesRequest":{"type":"object","description":"SetActiveAlertPoliciesRequest is the shape of the request for SetActiveAlertPolicies.","title":"SetActiveAlertPoliciesRequest","x-displayname":"Request for SetActiveAlertPolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveAlertPoliciesRequest","properties":{"alert_policies":{"type":"array","description":" A list of references to alert_policy objects.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n","title":"alert_policies","maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Alert Policies","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32"}},"namespace":{"type":"string","description":" The name of the namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"namespaceSetActiveAlertPoliciesResponse":{"type":"object","description":"SetActiveAlertPoliciesResponse is the shape of the response for SetActiveAlertPolicies.","title":"SetActiveAlertPoliciesResponse","x-displayname":"Response for SetActiveAlertPolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveAlertPoliciesResponse"},"namespaceSetActiveNetworkPoliciesRequest":{"type":"object","description":"SetActiveNetworkPoliciesRequest is the shape of the request for SetActiveNetworkPolicies.","title":"SetActiveNetworkPoliciesRequest","x-displayname":"Request for SetActiveNetworkPolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveNetworkPoliciesRequest","properties":{"namespace":{"type":"string","description":" The name of the namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"network_policies":{"type":"array","description":" A list of references to network_policy objects.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n","title":"network_policies","maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Network Policies","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32"}}}},"namespaceSetActiveNetworkPoliciesResponse":{"type":"object","description":"SetActiveNetworkPoliciesResponse is the shape of the response for SetActiveNetworkPolicies.","title":"SetActiveNetworkPoliciesResponse","x-displayname":"Response for SetActiveNetworkPolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveNetworkPoliciesResponse"},"namespaceSetActiveServicePoliciesRequest":{"type":"object","description":"SetActiveServicePoliciesRequest is the shape of the request for SetActiveServicePolicies.","title":"SetActiveServicePoliciesRequest","x-displayname":"Request for SetActiveServicePolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveServicePoliciesRequest","properties":{"namespace":{"type":"string","description":" The name of the namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"service_policies":{"type":"array","description":" Service Policies is a sequential engine where policies (and rules within the policy) are evaluated one after the other. It's important to define the\n correct order (policies evaluated from top to bottom in the list) for service policies, to get the intended result.\n For each request, its characteristics are evaluated based on the match criteria in each service policy starting at the top. If there is a match in the\n current policy, then the policy takes effect, and no more policies are evaluated. Otherwise, the next policy is evaluated.\n If all policies are evaluated and none match, then the request will be denied by default.\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 32\n","title":"service_policies","maxItems":32,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"Service Policies","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"32"}}}},"namespaceSetActiveServicePoliciesResponse":{"type":"object","description":"SetActiveServicePoliciesResponse is the shape of the response for SetActiveServicePolicies.","title":"SetActiveServicePoliciesResponse","x-displayname":"Response for SetActiveServicePolicies","x-ves-proto-message":"ves.io.schema.namespace.SetActiveServicePoliciesResponse"},"namespaceSetFastACLsForInternetVIPsRequest":{"type":"object","description":"SetFastACLsForInternetVIPsRequest contains list of FastACLs refs that\nshould be applied to the Internet VIPs","title":"SetFastACLsForInternetVIPsRequest","x-displayname":"Request for SetFastACLsForInternetVIP","x-ves-proto-message":"ves.io.schema.namespace.SetFastACLsForInternetVIPsRequest","properties":{"fast_acls":{"type":"array","description":" The list of refs of FastACLs\n\nExample: ` \"list of refs\"`\n\nValidation Rules:\n  ves.io.schema.rules.repeated.max_items: 128\n","title":"fast_acls","maxItems":128,"items":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"x-displayname":"FastACLs","x-ves-example":"list of refs","x-ves-validation-rules":{"ves.io.schema.rules.repeated.max_items":"128"}},"namespace":{"type":"string","description":" The name of the namespace\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"}}},"namespaceSetFastACLsForInternetVIPsResponse":{"type":"object","description":"SetFastACLsForInternetVIPsResponse is empty","title":"SetFastACLsForInternetVIPsResponse","x-displayname":"Response for SetFastACLsForInternetVIPs","x-ves-proto-message":"ves.io.schema.namespace.SetFastACLsForInternetVIPsResponse"},"namespaceSeverity":{"type":"string","description":"List of all supported severities\n\nERROR\nINFO\nWARNING\nSUCCESS","title":"Severity","enum":["ERROR","INFO","WARNING","SUCCESS"],"default":"ERROR","x-displayname":"Severity of message","x-ves-proto-enum":"ves.io.schema.namespace.Severity"},"namespaceSuggestValuesReq":{"type":"object","description":"Request body of SuggestValues request","title":"SuggestValuesReq","x-displayname":"Request for SuggestValues","x-ves-proto-message":"ves.io.schema.namespace.SuggestValuesReq","properties":{"field_path":{"type":"string","description":" JSON path of the field for which the suggested values are being requested.\n\nExample: ` \"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 1024\n","title":"field_path","maxLength":1024,"x-displayname":"Field Path","x-ves-example":"spec.rule_choice.rule_list.rules[2].spec.api_group_matcher.match","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"1024"}},"match_value":{"type":"string","description":" A substring that must be present in either the value or description of each SuggestedItem in the response.\n\nExample: ` \"some-substring\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_len: 256\n","title":"match_value","maxLength":256,"x-displayname":"Match Value","x-ves-example":"some-substring","x-ves-validation-rules":{"ves.io.schema.rules.string.max_len":"256"}},"namespace":{"type":"string","description":" Namespace in which the suggestions are scoped.\n\nExample: ` \"foobar\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"foobar"},"request_body":{"$ref":"#/components/schemas/protobufAny"}}},"namespaceTCPLoadbalancerInventoryFilterType":{"type":"object","description":"TCP Loadbalancer inventory Filter","title":"TCPLoadbalancerInventoryFilterType","x-displayname":"Filter for Inventory of TCP Loadbalancers","x-ves-proto-message":"ves.io.schema.namespace.TCPLoadbalancerInventoryFilterType","properties":{"namespace_service_policy":{"type":"boolean","description":" Filter results with TCP loadbalancers with Namespace Service Policy configured","title":"Namespace Service Policy","format":"boolean","x-displayname":"Namespace Service Policy"},"private_advertisement":{"type":"boolean","description":" Filter results with TCP loadbalancers advertised privately","title":"Private Advertisement","format":"boolean","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"boolean","description":" Filter results with TCP loadbalancers advertised publicly","title":"Public Advertisement","format":"boolean","x-displayname":"Public Advertisement"},"service_policy":{"type":"boolean","description":" Filter results with TCP loadbalancers with Service Policy configured","title":"Service Policy","format":"boolean","x-displayname":"Service Policy"},"tls_encryption":{"type":"boolean","description":" Filter results with TCP loadbalancers with TLS Encryption configured","title":"TLS Encryption","format":"boolean","x-displayname":"TLS Encryption"}}},"namespaceTCPLoadbalancerInventoryType":{"type":"object","description":"TCP Loadbalancer inventory","title":"TCPLoadbalancerInventoryType","x-displayname":"Inventory of TCP Loadbalancers","x-ves-proto-message":"ves.io.schema.namespace.TCPLoadbalancerInventoryType","properties":{"namespace_service_policy":{"type":"integer","description":" Number of TCP loadbalancers with Namespace Service Policy configured","title":"Namespace Service Policy","format":"int64","x-displayname":"Namespace Service Policy"},"private_advertisement":{"type":"integer","description":" Number of TCP loadbalancers advertised privately","title":"Private Advertisement","format":"int64","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"integer","description":" Number of TCP loadbalancers advertised publicly","title":"Public Advertisement","format":"int64","x-displayname":"Public Advertisement"},"service_policy":{"type":"integer","description":" Number of TCP loadbalancers with Service Policy configured","title":"Service Policy","format":"int64","x-displayname":"Service Policy"},"tcplb_results":{"type":"array","description":" List of TCP loadbalancers","title":"TCP Loadbalancers","items":{"$ref":"#/components/schemas/namespaceTCPLoadbalancerResultType"},"x-displayname":"List of TCP Loadbalancers"},"tls_encryption":{"type":"integer","description":" Number of TCP loadbalancers with TLS Encryption configured","title":"TLS Encryption","format":"int64","x-displayname":"TLS Encryption"}}},"namespaceTCPLoadbalancerResultType":{"type":"object","description":"TCP Loadbalancer Inventory Results","title":"TCPLoadbalancerResultType","x-displayname":"TCP Loadbalancer Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.TCPLoadbalancerResultType","properties":{"name":{"type":"string","description":" Name of TCP LB","title":"TCP LB Name","x-displayname":"TCP LB Name"},"namespace":{"type":"string","description":" Namespace of TCP LB","title":"TCP LB Namespace","x-displayname":"TCP LB Namespace"},"namespace_service_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"private_advertisement":{"$ref":"#/components/schemas/ioschemaEmpty"},"public_advertisment":{"$ref":"#/components/schemas/ioschemaEmpty"},"rate_limit":{"$ref":"#/components/schemas/ioschemaEmpty"},"service_policy":{"$ref":"#/components/schemas/ioschemaEmpty"},"tls_encryption":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"namespaceThirdPartyApplicationFilterType":{"type":"object","description":"Third Party Application Inventory Filter","title":"ThirdPartyApplicationFilterType","x-displayname":"Filter for Third Party ApplicationInventory","x-ves-proto-message":"ves.io.schema.namespace.ThirdPartyApplicationFilterType","properties":{"api_discovery":{"type":"boolean","description":" Filter results with Third Party Application with API Discovery","title":"API Discovery","format":"boolean","x-displayname":"API Discovery"}}},"namespaceThirdPartyApplicationInventoryType":{"type":"object","description":"Third Party Application inventory","title":"ThirdPartyApplicationInventoryType","x-displayname":"Inventory of Third Party Application","x-ves-proto-message":"ves.io.schema.namespace.ThirdPartyApplicationInventoryType","properties":{"api_discovery":{"type":"integer","description":" Number of Third Party Application with API Discovery enabled","title":"API Discovery","format":"int64","x-displayname":"API Discovery"},"third_party_application_results":{"type":"array","description":" List of Third Party Applications","title":"ThirdPartyApplicationType","items":{"$ref":"#/components/schemas/namespaceThirdPartyApplicationResultType"},"x-displayname":"List of Third Party Applications"}}},"namespaceThirdPartyApplicationResultType":{"type":"object","description":"Third Party Application Inventory Results","title":"ThirdPartyApplicationType","x-displayname":"Third Party Application Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.ThirdPartyApplicationResultType","properties":{"api_discovery_enabled":{"$ref":"#/components/schemas/ioschemaEmpty"},"name":{"type":"string","description":" Name of Third Party Application","title":"Third Party Application Name","x-displayname":"Third Party Application Name"}}},"namespaceUDPLoadbalancerInventoryFilterType":{"type":"object","description":"UDP Loadbalancer inventory Filter","title":"UDPLoadbalancerInventoryFilterType","x-displayname":"Filter for Inventory of UDP Loadbalancers","x-ves-proto-message":"ves.io.schema.namespace.UDPLoadbalancerInventoryFilterType","properties":{"private_advertisement":{"type":"boolean","description":" Filter results with UDP loadbalancers advertised privately","title":"Private Advertisement","format":"boolean","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"boolean","description":" Filter results with UDP loadbalancers advertised publicly","title":"Public Advertisement","format":"boolean","x-displayname":"Public Advertisement"}}},"namespaceUDPLoadbalancerInventoryType":{"type":"object","description":"UDP Loadbalancer inventory","title":"UDPLoadbalancerInventoryType","x-displayname":"Inventory of UDP Loadbalancers","x-ves-proto-message":"ves.io.schema.namespace.UDPLoadbalancerInventoryType","properties":{"private_advertisement":{"type":"integer","description":" Number of UDP loadbalancers advertised privately","title":"Private Advertisement","format":"int64","x-displayname":"Private Advertisement"},"public_advertisment":{"type":"integer","description":" Number of UDP loadbalancers advertised publicly","title":"Public Advertisement","format":"int64","x-displayname":"Public Advertisement"},"udplb_results":{"type":"array","description":" List of UDP loadbalancers","title":"UDP Loadbalancers","items":{"$ref":"#/components/schemas/namespaceUDPLoadbalancerResultType"},"x-displayname":"List of UDP Loadbalancers"}}},"namespaceUDPLoadbalancerResultType":{"type":"object","description":"UDP Loadbalancer Inventory Results","title":"UDPLoadbalancerResultType","x-displayname":"UDP Loadbalancer Inventory Results","x-ves-proto-message":"ves.io.schema.namespace.UDPLoadbalancerResultType","properties":{"name":{"type":"string","description":" Name of UDP LB","title":"UDP LB Name","x-displayname":"UDP LB Name"},"namespace":{"type":"string","description":" Namespace of UDP LB","title":"UDP LB Namespace","x-displayname":"UDP LB Namespace"},"private_advertisement":{"$ref":"#/components/schemas/ioschemaEmpty"},"public_advertisment":{"$ref":"#/components/schemas/ioschemaEmpty"}}},"namespaceUpdateAllowAdvertiseOnPublicReq":{"type":"object","description":"Request body of UpdateAllowAdvertiseOnPublic request","title":"UpdateAllowAdvertiseOnPublicReq","x-displayname":"Request for UpdateAllowAdvertiseOnPublic","x-ves-proto-message":"ves.io.schema.namespace.UpdateAllowAdvertiseOnPublicReq","properties":{"allow_advertise_on_public":{"$ref":"#/components/schemas/namespacePublicAdvertiseChoice"},"namespace":{"type":"string","description":" Name of the namespace under which all the URLs in APIItems will be evaluated\n\nExample: ` \"value\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"value"}}},"namespaceUpdateAllowAdvertiseOnPublicResp":{"type":"object","description":"Response body of UpdateAllowAdvertiseOnPublic request","title":"UpdateAllowAdvertiseOnPublicResp","x-displayname":"Response for UpdateAllowAdvertiseOnPublic","x-ves-proto-message":"ves.io.schema.namespace.UpdateAllowAdvertiseOnPublicResp","properties":{"result":{"type":"boolean","description":" API result.","title":"result","format":"boolean","x-displayname":"Result"}}},"namespaceValidateRulesReq":{"type":"object","description":"Request body of ValidateRulesReq request","title":"ValidateRulesReq","x-displayname":"Request for validating according to rules specified in the validator_evaluation","x-ves-proto-message":"ves.io.schema.namespace.ValidateRulesReq","properties":{"namespace":{"type":"string","description":" The name of the namespace which will be system in this case.\n\nExample: ` \"system\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"system"},"validator_evaluation":{"type":"object","description":" Map contains vaidators which needs to be evaluated\n\nExample: ` \"The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. true\"`","title":"validator evaluation","x-displayname":"Validator evaluation","x-ves-example":"The map key would be the validator type e.g. XStringRegex and the map value is the validator value e.g. true"},"value":{"type":"string","description":" The value to be validated\n\nExample: ` \"value\"`","title":"value","x-displayname":"Value","x-ves-example":"value"}}},"namespaceValidateRulesResponse":{"type":"object","description":"Response body of ValidateRulesReq request","title":"ValidateRulesResponse","x-displayname":"Response for ValidateRulesReq","x-ves-proto-message":"ves.io.schema.namespace.ValidateRulesResponse","properties":{"error":{"type":"string","description":" Error returned in case the value does not match the validator rules.","title":"error","x-displayname":"Error"},"success":{"type":"boolean","description":" This will set true if validation is successful on value","title":"success","format":"boolean","x-displayname":"Success"},"validation_results":{"type":"array","description":" This will return a list of validation results based on validators passed as input.   ","title":"Validation Results","items":{"$ref":"#/components/schemas/namespaceValidationResult"},"x-displayname":"Validation Results"}}},"namespaceValidationResult":{"type":"object","x-ves-proto-message":"ves.io.schema.namespace.ValidationResult","properties":{"message":{"type":"string","description":" Information message will be returned for inline notification and error messages for validation rules.","title":"Messsge","x-displayname":"Message"},"severity":{"$ref":"#/components/schemas/namespaceSeverity"}}},"protobufAny":{"type":"object","description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := ptypes.MarshalAny(foo)\n     ...\n     foo := &pb.Foo{}\n     if err := ptypes.UnmarshalAny(any, foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }","properties":{"type_url":{"type":"string","description":"A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."},"value":{"type":"string","description":"Must be a valid serialized protocol buffer of the above specified type.","format":"byte"}}},"schemaConditionType":{"type":"object","description":"Conditions are used in the object status to describe the current state of the\nobject, e.g. Ready, Succeeded, etc.","title":"ConditionType","x-displayname":"Status Condition","x-ves-proto-message":"ves.io.schema.ConditionType","properties":{"hostname":{"type":"string","description":" Hostname of the instance of the site that sent the status","title":"hostname","x-displayname":"Hostname"},"last_update_time":{"type":"string","description":" Last time the condition was updated","title":"last_update_time","format":"date-time","x-displayname":"Last Updated"},"reason":{"type":"string","description":" x-reason: \"Insufficient memory in data plane\"\n A human readable string explaining the reason for reaching this condition\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"service_name":{"type":"string","description":" Name of the service that sent the status","title":"service name","x-displayname":"Service Name"},"status":{"type":"string","description":" Status of the condition\n \"Success\" Validtion has succeded. Requested operation was successful.\n \"Failed\"  Validation has failed.\n \"Incomplete\" Validation of configuration has failed due to missing configuration.\n \"Installed\" Validation has passed and configuration has been installed in data path or K8s\n \"Down\" Configuration is operationally down. e.g. down interface\n \"Disabled\" Configuration is administratively disabled i.e. ObjectMetaType.Disable = true.\n \"NotApplicable\" Configuration is not applicable e.g. tenant service_policy_set(s) in system namespace are not applicable on REs\n\nExample: ` \"Failed\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]\n","title":"status","x-displayname":"Status","x-ves-example":"Failed","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Success\\\",\\\"Failed\\\",\\\"Incomplete\\\",\\\"Installed\\\",\\\"Down\\\",\\\"Disabled\\\",\\\"NotApplicable\\\"]"}},"type":{"type":"string","description":" Type of the condition\n \"Validation\" represents validation user given configuration object\n \"Operational\" represents operational status of a given configuration object\n\nExample: ` \"Operational\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.in: [\\\"Validation\\\",\\\"Operational\\\"]\n","title":"type","x-displayname":"Type","x-ves-example":"Operational","x-ves-validation-rules":{"ves.io.schema.rules.string.in":"[\\\"Validation\\\",\\\"Operational\\\"]"}}}},"schemaErrorCode":{"type":"string","description":"Union of all possible error-codes from system\n\n - EOK: No error\n - EPERMS: Permissions error\n - EBADINPUT: Input is not correct\n - ENOTFOUND: Not found\n - EEXISTS: Already exists\n - EUNKNOWN: Unknown/catchall error\n - ESERIALIZE: Error in serializing/de-serializing\n - EINTERNAL: Server error\n - EPARTIAL: Partial error","title":"ErrorCode","enum":["EOK","EPERMS","EBADINPUT","ENOTFOUND","EEXISTS","EUNKNOWN","ESERIALIZE","EINTERNAL","EPARTIAL"],"default":"EOK","x-displayname":"Error Code","x-ves-proto-enum":"ves.io.schema.ErrorCode"},"schemaErrorType":{"type":"object","description":"Information about a error in API operation","title":"ErrorType","x-displayname":"Error Type","x-ves-proto-message":"ves.io.schema.ErrorType","properties":{"code":{"$ref":"#/components/schemas/schemaErrorCode"},"error_obj":{"$ref":"#/components/schemas/protobufAny"},"message":{"type":"string","description":" A human readable string of the error\n\nExample: ` \"value\"`","title":"message","x-displayname":"Message","x-ves-example":"value"}}},"schemaInitializerType":{"type":"object","description":"Initializer is information about an initializer that has not yet completed.","title":"InitializerType","x-displayname":"Initializer","x-ves-proto-message":"ves.io.schema.InitializerType","properties":{"name":{"type":"string","description":" name of the service that is responsible for initializing this object.","title":"name","x-displayname":"Name"}}},"schemaInitializersType":{"type":"object","description":"Initializers tracks the progress of initialization of a configuration object","title":"InitializersType","x-displayname":"Initializers","x-ves-proto-message":"ves.io.schema.InitializersType","properties":{"pending":{"type":"array","description":" Pending is a list of initializers that must execute in order before this object is initialized.\n When the last pending initializer is removed, and no failing result is set, the initializers\n struct will be set to nil and the object is considered as initialized and visible to all\n clients.","title":"pending","items":{"$ref":"#/components/schemas/schemaInitializerType"},"x-displayname":"Pending"},"result":{"$ref":"#/components/schemas/schemaStatusType"}}},"schemaObjectCreateMetaType":{"type":"object","description":"ObjectCreateMetaType is metadata that can be specified in Create request of an object.","title":"ObjectCreateMetaType","x-displayname":"Create Metadata","x-ves-proto-message":"ves.io.schema.ObjectCreateMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectGetMetaType":{"type":"object","description":"ObjectGetMetaType is metadata that can be specified in Get/Create response of an object.","title":"ObjectGetMetaType","x-displayname":"Get Metadata","x-ves-proto-message":"ves.io.schema.ObjectGetMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotation","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable","x-ves-example":"true"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaObjectReplaceMetaType":{"type":"object","description":"ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.","title":"ObjectReplaceMetaType","x-displayname":"Replace Metadata","x-ves-proto-message":"ves.io.schema.ObjectReplaceMetaType","properties":{"annotations":{"type":"object","description":" Annotations is an unstructured key value map stored with a resource that may be\n set by external tools to store and retrieve arbitrary metadata. They are not\n queryable and should be preserved when modifying objects.\n\nExample: ` \"value\"`\n\nValidation Rules:\n  ves.io.schema.rules.map.keys.string.max_len: 64\n  ves.io.schema.rules.map.keys.string.min_len: 1\n  ves.io.schema.rules.map.values.string.max_len: 1024\n  ves.io.schema.rules.map.values.string.min_len: 1\n","title":"annotations","x-displayname":"Annotations","x-ves-example":"value","x-ves-validation-rules":{"ves.io.schema.rules.map.keys.string.max_len":"64","ves.io.schema.rules.map.keys.string.min_len":"1","ves.io.schema.rules.map.values.string.max_len":"1024","ves.io.schema.rules.map.values.string.min_len":"1"}},"description":{"type":"string","description":" Human readable description for the object\n\nExample: ` \"Virtual Host for acmecorp website\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 1200\n","title":"description","maxLength":1200,"x-displayname":"Description","x-ves-example":"Virtual Host for acmecorp website","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"1200"}},"disable":{"type":"boolean","description":" A value of true will administratively disable the object\n\nExample: ` \"true\"`","title":"disable","format":"boolean","x-displayname":"Disable"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the user. Values specified here will be used\n by selector expression\n\nExample: ` \"value\"`","title":"labels","x-displayname":"Labels","x-ves-example":"value"},"name":{"type":"string","description":" This is the name of configuration object. It has to be unique within the namespace.\n It can only be specified during create API and cannot be changed during replace API.\n The value of name has to follow DNS-1035 format.\n\nExample: ` \"acmecorp-web\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n","title":"name","x-displayname":"Name","x-ves-example":"acmecorp-web","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true"}},"namespace":{"type":"string","description":" This defines the workspace within which each the configuration object is to be created.\n Must be a DNS_LABEL format. For a namespace object itself, namespace value will be \"\"\n\nExample: ` \"staging\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"staging"}}},"schemaStatusMetaType":{"type":"object","description":"StatusMetaType is metadata that all status must have.","title":"StatusMetaType","x-displayname":"Metadata","x-ves-proto-message":"ves.io.schema.StatusMetaType","properties":{"creation_timestamp":{"type":"string","description":" creation_timestamp is when the status object was created. It is used to find/tie-break\n for latest status object from same origin","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" Class of creator which created this StatusObject. This will be service's DNS FQDN.\n This will be set by the system based on client certificate information.\n\nExample: ` \"ver.re1.int.ves.io\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"ver.re1.int.ves.io"},"creator_id":{"type":"string","description":" ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g.\n identifying the environment also). This will be set by the system based on client certificate\n information\n\nExample: ` \"ver-instance-1\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"ver-instance-1"},"publish":{"$ref":"#/components/schemas/schemaStatusPublishType"},"status_id":{"type":"string","description":" status_id is a field used by the generator to distinguish (if necessary) between two status\n objects for the same config object from the same site and same service and potentially same\n daemon(creator-id)","title":"status_id","x-displayname":"Status ID"},"uid":{"type":"string","description":" uid is the unique in time and space value for a StatusObject.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"},"vtrp_id":{"type":"string","description":" Origin of this status exchanged by VTRP.","title":"vtrp_id","x-displayname":"VTRP ID"},"vtrp_stale":{"type":"boolean","description":" Indicate whether mars deems this object to be stale via graceful restart timer information","title":"vtrp_stale","format":"boolean","x-displayname":"VTRP Stale"}}},"schemaStatusPublishType":{"type":"string","description":"StatusPublishType is all possible publish operations on a StatusObject\n\n - STATUS_DO_NOT_PUBLISH: Do Not Publish\n\nDo not propagate this status to user. This could be because status is only informational\n - STATUS_PUBLISH: Publish\n\nPropagate this status up to user as it might be actionable","title":"StatusPublishType","enum":["STATUS_DO_NOT_PUBLISH","STATUS_PUBLISH"],"default":"STATUS_DO_NOT_PUBLISH","x-displayname":"Status Publish Type","x-ves-proto-enum":"ves.io.schema.StatusPublishType"},"schemaStatusType":{"type":"object","description":"Status is a return value for calls that don't return other objects.","title":"StatusType","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.StatusType","properties":{"code":{"type":"integer","description":" Suggested HTTP return code for this status, 0 if not set.\n\nExample: ` \"0\"`","title":"code","format":"int32","x-displayname":"Code","x-ves-example":"0"},"reason":{"type":"string","description":" A human-readable description of why this operation is in the\n \"Failure\" status. If this value is empty there\n is no information available.\n\nExample: ` \"value\"`","title":"reason","x-displayname":"Reason","x-ves-example":"value"},"status":{"type":"string","description":" Status of the operation.\n One of: \"Success\" or \"Failure\".\n\nExample: ` \"value\"`","title":"status","x-displayname":"Status","x-ves-example":"value"}}},"schemaSystemObjectGetMetaType":{"type":"object","description":"SystemObjectGetMetaType is metadata generated or populated by the system for all persisted objects and\ncannot be updated directly by users.","title":"SystemObjectGetMetaType","x-displayname":"System Metadata","x-ves-proto-message":"ves.io.schema.SystemObjectGetMetaType","properties":{"creation_timestamp":{"type":"string","description":" CreationTimestamp is a timestamp representing the server time when this object was\n created. It is not guaranteed to be set in happens-before order across separate operations.\n Clients may not set this value. It is represented in RFC3339 form and is in UTC.","title":"creation_timestamp","format":"date-time","x-displayname":"Creation Timestamp"},"creator_class":{"type":"string","description":" A value identifying the class of the user or service which created this configuration object.\n\nExample: ` \"value\"`","title":"creator_class","x-displayname":"Creator Class","x-ves-example":"prism"},"creator_id":{"type":"string","description":" A value identifying the exact user or service that created this configuration object\n\nExample: ` \"value\"`","title":"creator_id","x-displayname":"Creator ID","x-ves-example":"admin@acmecorp.com"},"deletion_timestamp":{"type":"string","description":" DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This\n field is set by the server when a graceful deletion is requested by the user, and is not\n directly settable by a client. The resource is expected to be deleted (no longer visible\n from resource lists, and not reachable by name) after the time in this field, once the\n finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.\n Once the deletionTimestamp is set, this value may not be unset or be set further into the\n future, although it may be shortened or the resource may be deleted prior to this time.\n For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react\n by sending a graceful termination signal to the containers in the pod. After that 30 seconds,\n the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,\n remove the pod from the API. In the presence of network partitions, this object may still\n exist after this timestamp, until an administrator or automated process can determine the\n resource is fully terminated.\n If not set, graceful deletion of the object has not been requested.\n\n Populated by the system when a graceful deletion is requested.\n Read-only.","title":"deletion_timestamp","format":"date-time","x-displayname":"Deletion Timestamp"},"finalizers":{"type":"array","description":" Must be empty before the object is deleted from the registry. Each entry\n is an identifier for the responsible component that will remove the entry\n from the list. If the deletionTimestamp of the object is non-nil, entries\n in this list can only be removed.\n\nExample: ` \"value\"`","title":"finalizers","items":{"type":"string"},"x-displayname":"Finalizers","x-ves-example":"value"},"initializers":{"$ref":"#/components/schemas/schemaInitializersType"},"labels":{"type":"object","description":" Map of string keys and values that can be used to organize and categorize\n (scope and select) objects as chosen by the operator or software. Values here can be interpreted\n by software(backend or frontend) to enable certain behavior e.g. things marked as soft-deleted(restorable).\n\nExample: ` \"'ves.io/soft-deleted''true'\"`","title":"labels","x-displayname":"Labels","x-ves-example":"'ves.io/soft-deleted': 'true'"},"modification_timestamp":{"type":"string","description":" ModificationTimestamp is a timestamp representing the server time when this object was\n last modified.","title":"modification_timestamp","format":"date-time","x-displayname":"Modification Timestamp"},"object_index":{"type":"integer","description":" Unique index for the object. Some objects need a unique integer index to be allocated\n for each object type. This field will be populated for all objects that need it and will\n be zero otherwise.\n\nExample: ` \"0\"`","title":"object_index","format":"int64","x-displayname":"Object Index","x-ves-example":"0"},"owner_view":{"$ref":"#/components/schemas/schemaViewRefType"},"tenant":{"type":"string","description":" Tenant to which this configuration object belongs to. The value for this is found from\n presented credentials.\n\nExample: ` \"acmecorp\"`","title":"tenant","x-displayname":"Tenant","x-ves-example":"acmecorp"},"uid":{"type":"string","description":" uid is the unique in time and space value for this object. It is generated by\n the server on successful creation of an object and is not allowed to change on Replace\n API. The value of is taken from uid field of ObjectMetaType, if provided.\n\nExample: ` \"d15f1fad-4d37-48c0-8706-df1824d76d31\"`","title":"uid","x-displayname":"UID","x-ves-example":"d15f1fad-4d37-48c0-8706-df1824d76d31"}}},"schemaViewRefType":{"type":"object","description":"ViewRefType represents a reference to a view","title":"ViewRefType","x-displayname":"View Reference","x-ves-proto-message":"ves.io.schema.ViewRefType","properties":{"kind":{"type":"string","description":" Kind of the view object\n\nExample: ` \"http_proxy\"`","title":"kind","x-displayname":"Kind","x-ves-example":"http_proxy"},"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contactus-route\"`","title":"name","x-displayname":"Name","x-ves-example":"contactus-route"},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`","title":"namespace","x-displayname":"Namespace","x-ves-example":"ns1"},"uid":{"type":"string","description":" UID of the view object\n\nExample: ` \"f3744323-1adf-4aaa-a5dc-0707c1d1bd82\"`","title":"uid","x-displayname":"UID","x-ves-example":"f3744323-1adf-4aaa-a5dc-0707c1d1bd82"}}},"schemanamespaceCreateSpecType":{"type":"object","description":"Creates a new namespace. Name of the object is name of the name space.","title":"Create namespace","x-displayname":"Create Namespace","x-ves-proto-message":"ves.io.schema.namespace.CreateSpecType"},"schemanamespaceGetSpecType":{"type":"object","description":"This is the read representation of the namespace object.","title":"Get namespace","x-displayname":"Get Namespace","x-ves-proto-message":"ves.io.schema.namespace.GetSpecType"},"schemanamespaceReplaceSpecType":{"type":"object","description":"Replaces attributes of a namespace including its metadata like labels, description etc.","title":"Replace namespace","x-displayname":"Replace Namespace","x-ves-proto-message":"ves.io.schema.namespace.ReplaceSpecType"},"schemanamespaceStatusObject":{"type":"object","description":"Most recently observed status of object.","title":"StatusObject","x-displayname":"Status","x-ves-proto-message":"ves.io.schema.namespace.StatusObject","properties":{"conditions":{"type":"array","description":" Conditions represent the normalized status values for configuration object.","title":"Conditions","items":{"$ref":"#/components/schemas/schemaConditionType"},"x-displayname":"Conditions"},"metadata":{"$ref":"#/components/schemas/schemaStatusMetaType"},"object_refs":{"type":"array","description":" A namespace direct reference.","title":"ObjectRefs","items":{"$ref":"#/components/schemas/ioschemaObjectRefType"},"x-displayname":"Config Object"}}},"schemanamespaceSuggestValuesResp":{"type":"object","description":"Response body of SuggestValues request","title":"SuggestValuesResp","x-displayname":"Response for SuggestValues","x-ves-proto-message":"ves.io.schema.namespace.SuggestValuesResp","properties":{"items":{"type":"array","description":" List of suggested items.","title":"item_lists","items":{"$ref":"#/components/schemas/schemanamespaceSuggestedItem"},"x-displayname":"Suggested Items"}}},"schemanamespaceSuggestedItem":{"type":"object","description":"A tuple with a suggested value and it's description.","title":"SuggestedItem","x-displayname":"Suggested Item","x-ves-oneof-field-value_choice":"[\"ref_value\",\"str_value\"]","x-ves-proto-message":"ves.io.schema.namespace.SuggestedItem","properties":{"description":{"type":"string","description":" Optional description for the suggested value.","title":"description","x-displayname":"Description"},"ref_value":{"$ref":"#/components/schemas/schemaviewsObjectRefType"},"str_value":{"type":"string","description":"Exclusive with [ref_value]\n","title":"str_value","x-displayname":"String"},"title":{"type":"string","description":" Optional title to be displayed instead of the actual value.\n Used when pure value doesn't contain all the needed information to be displayed,\n or when display titles should be customized.","title":"title","x-displayname":"Title"},"value":{"type":"string","description":" Suggested value for the field.\n Should use value_choice.str_value instead.","title":"value","x-displayname":"Value"}}},"schemaviewsObjectRefType":{"type":"object","description":"This type establishes a direct reference from one object(the referrer) to another(the referred).\nSuch a reference is in form of tenant/namespace/name","title":"ObjectRefType","x-displayname":"Object reference","x-ves-proto-message":"ves.io.schema.views.ObjectRefType","properties":{"name":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then name will hold the referred object's(e.g. route's) name.\n\nExample: ` \"contacts-route\"`\n\nRequired: YES\n\nValidation Rules:\n  ves.io.schema.rules.message.required: true\n  ves.io.schema.rules.string.max_bytes: 128\n  ves.io.schema.rules.string.min_bytes: 1\n","title":"name","minLength":1,"maxLength":128,"x-displayname":"Name","x-ves-example":"contacts-route","x-ves-required":"true","x-ves-validation-rules":{"ves.io.schema.rules.message.required":"true","ves.io.schema.rules.string.max_bytes":"128","ves.io.schema.rules.string.min_bytes":"1"}},"namespace":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then namespace will hold the referred object's(e.g. route's) namespace.\n\nExample: ` \"ns1\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"namespace","maxLength":64,"x-displayname":"Namespace","x-ves-example":"ns1","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}},"tenant":{"type":"string","description":" When a configuration object(e.g. virtual_host) refers to another(e.g route)\n then tenant will hold the referred object's(e.g. route's) tenant.\n\nExample: ` \"acmecorp\"`\n\nValidation Rules:\n  ves.io.schema.rules.string.max_bytes: 64\n","title":"tenant","maxLength":64,"x-displayname":"Tenant","x-ves-example":"acmecorp","x-ves-validation-rules":{"ves.io.schema.rules.string.max_bytes":"64"}}}},"virtual_hostVirtualHostType":{"type":"string","description":"VirtualHostType tells the type of virtual_host. Functionally, all types are same,\nthis is mainly used for categorizing metrics.\n\n - VIRTUAL_SERVICE: VirtualService\n\nVirtual Host used Virtual Service\n - HTTP_LOAD_BALANCER: HTTP LoadBalancer\n\nVirtual Host used as Load Balancer\n - API_GATEWAY: APIGateway\n\nVirtual Host used API Gateway\n - TCP_LOAD_BALANCER: TCP LoadBalancer\n\nVirtual Host used as Load Balancer\n - PROXY: Proxy\n\nVirtual Host used as Proxy\n - LOCAL_K8S_API_GATEWAY: LOCAL_K8S_API_GATEWAY\n\nInternal use only, used for k8s cluster api gateway on the site.\n - CDN_LOAD_BALANCER: CDN LoadBalancer\n\n Virtual Host used as Load Balancer\n - NGINX_SERVER: NGINX Server\n\nVirtual Host representing an NGINX Server block\n - BIGIP_VIRTUAL_SERVER: BIG-IP Virtual Server\n\nVirtual Host representing a BIG-IP Virtual Server\n - UDP_LOAD_BALANCER: UDP LoadBalancer\n\nVirtual Host used as Load Balancer\n - THIRD_PARTY_APPLICATION: THIRD PARTY Virtual Server\n\nVirtual Host representing a Third Party Application","title":"VirtualHostType","enum":["VIRTUAL_SERVICE","HTTP_LOAD_BALANCER","API_GATEWAY","TCP_LOAD_BALANCER","PROXY","CDN_LOAD_BALANCER","NGINX_SERVER","UDP_LOAD_BALANCER"],"default":"VIRTUAL_SERVICE","x-displayname":"Virtual Host Type","x-ves-proto-enum":"ves.io.schema.virtual_host.VirtualHostType"}}}}