How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Zero Networks

Zero Networks Platform API

The Zero Networks platform REST API, exposing the segmentation and identity control surface of the Zero Networks console: assets and asset protection state, inbound and outbound segmentation rules, MFA (reactive) policies, RPC rules, Automation Engine exclusions, internal access policies, custom groups and group membership, users and roles, Kubernetes workloads, cloud connectors, audit and network/logon activity, and platform settings including webhooks and SIEM event export. Authentication is an API token minted in the console under Settings > API and sent in the Authorization header.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 40 operations across 1596 paths, organized into 9 resource areas, and defines 598 schemas. It is described by OpenAPI 3.0.1, at version 1.26.3.

Requests are made against a single base URL, https://portal.zeronetworks.com/v1/api.

40 operations 1596 paths 598 schemas 10 DELETE11 GET9 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.26.3
Base URL
https://portal.zeronetworks.com/api/v1
Authentication
API Key
Contact
Support
Resource Areas
9

Authentication & Security 1

Zero Networks Platform API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key). By default, every request must be authenticated.

Paths & Operations 40

Across 1596 paths, the API surfaces 40 operations — 10 DELETE, 11 GET, 9 POST, 10 PUT. They span 9 resource areas: Assets, Groups Custom, AE Exclusions, Internal Access Policy, MFA Inbound, MFA Outbound, Rules RPC, Rules Inbound, Rules Outbound. Each is listed below with its method, path, parameters, and response codes.

Assets 1

API calls related to Assets.

GET
/assets/searchId
Search Asset by FQDN
Assets_Search 1 param → 200400401403404500
Groups Custom 7

API calls related to Custom Groups.

POST
/groups/custom
Create Custom Group
CustomGroups_Create body → 200400401403409500
GET
/groups/custom/{groupId}
Get a custom group
CustomGroups_Get 1 param → 200400401403404500
PUT
/groups/custom/{groupId}
Update Custom Group
CustomGroups_Update 1 param body → 200400401403500
DELETE
/groups/custom/{groupId}
Delete Custom Group
CustomGroups_Delete 1 param → 200400401403500
GET
/groups/custom/{groupId}/members
List Custom Group members
CustomGroupMembers_List 1 param → 200400401403500
PUT
/groups/custom/{groupId}/members
Add Custom Group members
CustomGroupsMembers_Add 1 param body → 200400401403500
DELETE
/groups/custom/{groupId}/members
Delete Custom Group members
CustomGroupsMembers_Delete 1 param body → 200400401403500
AE Exclusions 8

API calls related to AE Exclusions.

POST
/protection/ae-exclusions/inbound
Create AE Exclusion Inbound
AEExclusionsInbound_Create body → 200400401403409500
GET
/protection/ae-exclusions/inbound/{ruleId}
Get AE Exclusion
AEExclusionsInbound_Get 1 param → 200400401403404500
DELETE
/protection/ae-exclusions/inbound/{ruleId}
Delete Automation Engine Inbound exclusions
AEExclusionsInbound_Delete 1 param → 200400401403404500
PUT
/protection/ae-exclusions/inbound/{ruleId}
Update AE Exclusion
AEExclusionsInbound_Update 1 param body → 200400401403404500
POST
/protection/ae-exclusions/outbound
Create AE Exclusion Outbound
AEExclusionsOutbound_Create body → 200400401403409500
GET
/protection/ae-exclusions/outbound/{ruleId}
Get AE Exclusion
AEExclusionsOutbound_Get 1 param → 200400401403404500
DELETE
/protection/ae-exclusions/outbound/{ruleId}
Delete Automation Engine Outbound exclusions
AEExclusionsOutbound_Delete 1 param → 200400401403404500
PUT
/protection/ae-exclusions/outbound/{ruleId}
Update AE Exclusion
AEExclusionsOutbound_Update 1 param body → 200400401403404500
Internal Access Policy 4
POST
/protection/internal-access/policies
Create an internal access policy
InternalAccessPolicy_Create body → 200400401403404500
GET
/protection/internal-access/policies/{policyId}
Get an Internal Access policy
InternalAccessPolicy_Get 1 param → 200400401403404500
PUT
/protection/internal-access/policies/{policyId}
Update an Internal Access policy
InternalAccessPolicy_Update 1 param body → 200400401403404500
DELETE
/protection/internal-access/policies/{policyId}
Delete an Internal Access policy
InternalAccessPolicy_Delete 1 param → 200400401403404500
MFA Inbound 4

API calls related to Inbound MFA policies.

POST
/protection/reactive-policies/inbound
Add Inbound MFA Policy
MFAInboundPolicies_Create body → 200400401403500
GET
/protection/reactive-policies/inbound/{reactivePolicyId}
Get Inbound MFA Policy
MFAInboundPolicies_Get 1 param → 200400401403404500
PUT
/protection/reactive-policies/inbound/{reactivePolicyId}
Update Inbound MFA Policy
MFAInboundPolicies_Update 1 param body → 200400401403404500
DELETE
/protection/reactive-policies/inbound/{reactivePolicyId}
Remove Inbound MFA Policy
MFAInboundPolicies_Delete 1 param → 200400401403404500
MFA Outbound 4

API calls related to Outbound MFA policies.

POST
/protection/reactive-policies/outbound
Add Outbound MFA Policy
MFAOutboundPolicies_Create body → 200400401403500
GET
/protection/reactive-policies/outbound/{reactivePolicyId}
Get Outbound MFA Policy
MFAOutboundPolicies_Get 1 param → 200400401403404500
PUT
/protection/reactive-policies/outbound/{reactivePolicyId}
Update Outbound MFA Policy
MFAOutboundPolicies_Update 1 param body → 200400401403500
DELETE
/protection/reactive-policies/outbound/{reactivePolicyId}
Remove Outbound MFA Policy
MFAOutboundPolicies_Delete 1 param → 200400401403404500
Rules RPC 4

API calls related to RPC Rules

POST
/protection/rpc-rules
Create RPC Rule
RPCRules_Create body → 200400401403409500
GET
/protection/rpc-rules/{ruleId}
Get RPC Rule
RPCRule_Get 1 param → 200400401403404500
PUT
/protection/rpc-rules/{ruleId}
Update RPC Rule
RPCRule_Update 1 param body → 200400401403404500
DELETE
/protection/rpc-rules/{ruleId}
Remove RPC Rule
RPCRule_Delete 1 param → 200400401403404500
Rules Inbound 4

API calls related to Inbound rules.

POST
/protection/rules/inbound
Create Inbound Rule
InboundRules_Create body → 200400401403409500
GET
/protection/rules/inbound/{ruleId}
Get Inbound Rule
InboundRule_Get 1 param → 200400401403404500
PUT
/protection/rules/inbound/{ruleId}
Update Inbound Rule
InboundRule_Update 1 param body → 200400401403404500
DELETE
/protection/rules/inbound/{ruleId}
Remove Inbound Rule
InboundRule_Delete 1 param → 200400401403404500
Rules Outbound 4

API calls related to Outbound rules.

POST
/protection/rules/outbound
Create Outbound Rule
OutboundRules_Create body → 200400401403409500
GET
/protection/rules/outbound/{ruleId}
Get Outbound Rule
OutboundRule_Get 1 param → 200400401403404500
PUT
/protection/rules/outbound/{ruleId}
Update Outbound Rule
OutboundRule_Update 1 param body → 200400401403404500
DELETE
/protection/rules/outbound/{ruleId}
Remove Outbound Rule
OutboundRule_Delete 1 param → 200400401403404500

Schemas 598

The contract defines 598 schemas that model the data the API accepts and returns. The most detailed are rule (48 properties), reactivePolicy (32 properties), switchRule (32 properties), identityReactivePolicy (27 properties). Each schema is shown below with its type and property counts.

accessInfo
object
2 properties
accessToken
object
Access Token
7 properties
accessTokenInfo
object
6 properties
accessTypeEnum
integer
1=Full Access, 2=Read Only, 3=Cloud Connector Provisioning
productType
integer
1=Cloud-Connector, 2=Segment-Connector, 3=Segment-Server, 4=Connect-Client, 5=Connect-Server
freezePeriodState
integer
1=Created, 2=Started, 3=About to end, 4=Ended
actionType
integer
'1' - Allow '2' - Block
activitiesAnalysisWidget
object
12 properties
resolvedFilter
object
4 properties
resolvedFilterMap
object
activitiesAnalysisWidgetBody
object
4 properties 4 required
activitiesAnalysisWidgetList
object
1 property
activitiesDistictValue
object
7 properties
activitiesDistictValuesList
object
1 property
activitiesList
object
2 properties
activity
object
11 properties
adDomain
object
2 properties
adDomainsList
object
1 property
aeExclusion
aeExclusionList
object
2 properties
aeExclusionRuleResponse
object
1 property
aeExclusionRuleBody
object
10 properties 4 required
asset
assetActivateBody
object
1 property
assetIdentityAnalysis
object
1 property
assetBasicInfo
assetBasicInfoList
object
1 property
assetCandidate
object
8 properties
assetIdSearch
object
1 property
assetList
object
2 properties
assetManager
object
4 properties
assetManagersBody
object
2 properties 2 required
assetManagersList
object
1 property
assetManagersUpdateBody
object
2 properties 2 required
assetNetworkAnalysis
object
1 property
assetOt
object
14 properties
assetOtList
object
3 properties
assetOtResponse
object
1 property
assetResponse
object
1 property
assetsActivateBody
object
2 properties 1 required
assetsBreakGlassBody
object
1 property 1 required
assetsIdentityQueueBody
object
2 properties 2 required
assetsMirrorBody
object
2 properties 2 required
assetsOrGroupsList
object
2 properties
assetsPreferredSegmentServer
object
1 property
assetsPreferredSegmentServerSetBody
object
2 properties 1 required
assetsPreferredSegmentServerBody
object
1 property 1 required
assetsProtectBody
object
1 property 1 required
assetsQueueBody
object
2 properties 2 required
assetsRpcBody
object
1 property 1 required
assetsRPCQueueBody
object
2 properties 2 required
assetsSegmentationStatistic
object
4 properties
assetsSegmentationStatistics
object
1 property
assetsStatesStatistics
object
1 property
assetsStatistics
object
1 property
assetStatus
integer
Possible asset status: '1' - Not monitored '2' - Segment server '4' - Can't be monitored (unsupported OS) '5' - Can't be monitored (unmonitorable) '6' - Can't…
enforcementMethod
integer
Possible values: '1' - Linux IP Tables '2' - Linux NF Tables '3' - Windows Firewall '4' - Windows WFP
assetSummary
object
3 properties
assetsUnprotectBody
object
1 property 1 required
assetType
integer
Possible asset status: '0' - Unknown '1' - Client '2' - Server '3' - Virtual cluster '4' - IP camera '5' - Smart TV '6' - Factory controller '7' - Medical devi…
audienceType
integer
dictionary: '0' PORTALAUDIENCE '1' SSPAUDIENCE '2' RPAUDIENCE
audit
object
10 properties
auditList
object
2 properties
auditType
integer
1 - Asset is being segmented (network) 2 - Asset segmented (network) 3 - Asset failed segmenting 4 - Asset is being unsegmented (network) 5 - Asset unsegmented…
authenticationPackageSummary
object
2 properties
azureTenantCredentialsBody
object
6 properties 6 required
azureTenantInfo
object
6 properties
azureTenantSyncStatus
object
3 properties
azureSubscriptionInfo
object
6 properties
azureSubscriptionsList
object
2 properties
azureSubscriptionResponse
object
1 property
azureSubscriptionsSyncConfigBody
object
2 properties 2 required
azureResourceGroupInfo
object
7 properties
azureResourceGroupsList
object
2 properties
azureResourceGroupResponse
object
1 property
byAsset
object
8 properties
byPort
object
8 properties
byProcess
object
8 properties
byUser
object
8 properties
candidatesList
object
2 properties
challengeBody
object
2 properties
challengeResponse
object
2 properties
clusterInfo
object
1 property
connectionState
integer
dictionary: '1' Blocked '2' Requested '3' Established '4' Blocked at source '5' All
connectionStatesCounts
object
3 properties
connectivityStateAfterReboot
integer
dictionary: '1' Previous connectivity state '2' Connected (Always-on) '3' Disconnected '4' Signed out
connectRegion
object
9 properties
connectRegionBody
object
4 properties 3 required
connectRegionsList
object
1 property
postureProfile
object
12 properties
postureProfileBody
object
6 properties 3 required
postureProfilesList
object
2 properties
postureCheckDefinitionsList
object
1 property
postureCheckDefinition
object
6 properties
postureCheckFieldDefinition
object
7 properties
postureCheckDropdownOption
object
3 properties
windowsPostureChecks
object
8 properties
macPostureChecks
object
7 properties
connectServer
object
12 properties
connectServerBody
object
1 property 1 required
connectServersList
object
1 property
connectUserAccessConfig
object
17 properties
connectUserAccessConfigBody
object
8 properties 7 required
connectUserAccessConfigList
object
1 property
createdBy
object
4 properties
createOtAssetResponse
object
1 property
customGroup
object
14 properties
customGroupBody
object
4 properties 1 required
customGroupMembersBody
object
1 property 1 required
customGroupResponse
object
1 property
customUser
object
14 properties
customUsersList
object
1 property
deployment
object
14 properties
deploymentsClusterSource
integer
'1' - System '2' - User '3' - Domain '4' - Subnet '5' - None '6' - N/A
deploymentsList
object
1 property
deploymentsClusters
object
7 properties
deploymentsClustersList
object
1 property
distribution
object
2 properties
downloadUrl
object
1 property
emptyResponse
object
moveCluster
object
2 properties
createCluster
object
2 properties
editCluster
object
3 properties
encodedEntity
object
1 property
enforcementSource
integer
'1' - ReactivePolicy '2' - Automated '3' - AccessPortal '4' - AdminPortal '5' - AI '6' - API '7' - Setup '8' - Connect '9' - System '10' - DownloadPortal '11'…
entityInactiveReason
integer
'1' - Repository Duplicated '2' - Manual '3' - None '4' - Repository Disabled '5' - Repository Inactive '6' - Repository Deleted
entitiesList
object
4 properties
entity
object
envConfig
object
2 properties
envConfigLicense
object
8 properties
epochMillis
integer
Epoch Millis
error
object
2 properties
exportBody
object
5 properties
switchInterfaceBody
object
2 properties 2 required
exportBodyActivities
object
5 properties 3 required
exportBodyAnalysis
object
4 properties 3 required
exportBodyAssets
object
2 properties 2 required
exportBodyRules
object
5 properties 4 required
exportId
object
1 property
exposureMeterStatistics
object
1 property
exposureMeterStatisticsItem
object
5 properties
exposureMeterStatisticsItemCounts
object
3 properties
externalAccessPolicy
object
17 properties
externalAccessPolicyBody
object
10 properties 6 required
externalAccessPolicyItem
object
1 property
externalAccessPolicyList
object
2 properties
externalAccessPolicyStatistics
object
1 property
externalIpsList
array
Collection of Internet IPs that are trusted
filter
object
12 properties
filtersList
object
5 properties
group
object
19 properties
groupBasicInfo
object
7 properties
groupAnalysis
object
1 property
groupCandidate
object
7 properties
groupCandidatesList
object
2 properties
groupConditions
object
6 properties
groupIdOrAssetId
string
groupIdOrUserId
string
groupResponse
object
1 property
groupItem
object
1 property
groupMembersList
object
1 property
groupSimulateSegmentationEntity
object
3 properties
groupSimulateSegmentationItem
object
8 properties
groupSimulateSegmentationReport
object
5 properties
groupSimulateSegmentationReportBody
object
4 properties
groupSimulateSegmentationReportRecord
array
groupSimulateSegmentationState
object
2 properties
groupsList
object
2 properties
groupsOrUsersList
object
2 properties
groupsStatistics
object
1 property
settingsFreezePeriod
object
7 properties
settingsFreezePeriodBody
object
3 properties 2 required
settingsFreezePeriodList
object
1 property
settingsFreezePeriodResponse
object
1 property
healthIssue
object
2 properties
healthStateObject
object
1 property
healthState
object
2 properties
historyRule
object
10 properties
identityAnalysis
object
8 properties
identityPostureViolation
object
11 properties
identityPostureViolationsList
object
2 properties
identityPostureCheckType
integer
'1' - Password Not Needed '2' - Use DES key only '3' - Dont Require PreAuth '4' - Password Never Expire '5' - Unconstrained Delegation Enabled '6' - Default Ad…
identityProtectionState
integer
Possible asset status: '0' - Unspecified '1' - Unsegmented '2' - Unspecified '3' - Segmented '4' - Unsegmented '5' - In learning '6' - Forced Unprotected '7' -…
identityReactivePolicy
object
27 properties
identityReactivePolicyBody
object
18 properties 9 required
identityReactivePolicyItem
object
1 property
identityReactivePolicyList
object
2 properties
identityReactivePolicyResponse
object
1 property
identityRule
object
19 properties
identityRuleBody
object
10 properties 5 required
identityRuleItem
object
1 property
identityRulesList
object
2 properties
idNamePair
object
2 properties
idNamePairList
object
1 property
inactiveAssetsConfig
object
1 property 1 required
inactiveAssetsConfigBody
object
1 property
inactiveReason
integer
'1' - Duplicated in asset repository '2' - Manually set as inactive '3' - None '4' - Disabled in asset repository '5' - Inactive in asset repository '6' - Dele…
interfaceUuidsList
array
one of the following: "rpcAnyInterface" for any interface List of interface uuids for explicit interfaces
internalAccessPolicy
object
16 properties
internalAccessPolicyBody
object
9 properties 6 required
internalAccessPolicyItem
object
1 property
internalAccessPolicyList
object
2 properties
ipSecOpt
integer
For allow rule only. '1' - Off '2' - Null encapsulation connections '3' - Authenticated and integrity-protected connections '4' - Encrypted connections and dyn…
ipSubnet
string
iso8601DateTimeUTC
string
ISO 8601 Date Time in UTC
k8s
object
18 properties
k8sApplication
object
4 properties
k8sApplicationEntity
object
1 property
k8sApplicationsList
object
2 properties
k8sBody
object
1 property 1 required
k8sCommands
object
7 properties
k8sEgressIp
object
7 properties
k8sEgressIpList
object
2 properties
k8sEntity
object
1 property
k8sEntityInfo
object
3 properties
k8sEntityType
integer
0 - Other 1 - Cluster 2 - Namespace 3 - Node 4 - Pod 5 - Deployment 6 - Daemonset 7 - Statefulset 8 - Job 9 - Service 10 - Network Policy 11 - Ingress 12 - Gat…
k8sItem
object
1 property
k8sLabel
object
6 properties
k8sLabelEntity
object
1 property
k8sLabelsList
object
2 properties
k8sList
object
2 properties
k8sNamespace
object
7 properties
k8sNamespaceEntity
object
1 property
k8sNamespacesList
object
2 properties
k8sNetworkPolicy
object
10 properties
k8sNetworkAnalysis
object
1 property
k8sNetworkPolicyList
object
2 properties
k8sNode
object
4 properties
k8sNodesList
object
2 properties
k8sRule
object
13 properties
k8sRuleDirection
integer
'1' - Ingress '2' - Egress
k8sRulesList
object
2 properties
k8sTranslatedEntity
object
5 properties
k8sTranslatedEntityType
integer
1 - Unsupported 2 - Namespace 3 - App 4 - Label 5 - App in Namespace 6 - Label in Namespace 7 - Namespace with constraints 8 - Labels 9 - Subnet 10 - Any
k8sWorkload
object
10 properties
k8sWorkloadEntity
object
1 property
k8sWorkloadsList
object
2 properties
labelsKeyCandidatesList
object
1 property
labelsValueCandidatesList
object
1 property
keyValuePair
object
2 properties
label
object
4 properties
labelsBody
object
1 property
removeLabelsBody
object
2 properties
labelsList
object
2 properties
labelsResponse
object
1 property
licensedUserInfo
object
5 properties
licensesConfig
object
1 property
licenseConfigBody
object
1 property
licensesInUse
object
2 properties
linuxBody
object
2 properties 2 required
linuxResponse
object
1 property
linuxScriptAvailable
object
1 property
listeningAddress
object
3 properties
listeningPort
object
4 properties
listeningPortsList
object
1 property
loginBody
object
2 properties
loginResponse
object
2 properties
logonActivitiesList
object
2 properties
logonActivity
object
13 properties
logonTypeSummary
object
2 properties
maintenanceWindow
object
9 properties
maintenanceWindowBody
object
4 properties 4 required
maintenanceWindowItem
object
1 property
maintenanceWindowItems
object
1 property
maintenanceWindowList
object
1 property
osType
integer
Possible osType: '1' - Unmanagable '2' - Windows '3' - Linux '4' - Mac
managedAsset
object
4 properties
managedAssetsBody
object
2 properties
managedAssetsUpdateBody
object
2 properties 2 required
managedAssetsList
object
1 property
manager
object
4 properties
managersList
object
1 property
mfaMethods
integer
'1' - SMS '2' - Email '3' - Duo '4' - Browser '5' - No MFA '6' - MicrosoftAuthenticator '7' - Okta
networkActivityMap
object
3 properties
networkActivityMapAnalysisResult
object
1 property
networkAssetAnalysisRecord
object
9 properties
networkAnalysisRecordData
object
6 properties
networkAnalysis
object
8 properties
nextBatch
object
3 properties
nonOtAssetType
integer
Possible asset status: '1' - Client '2' - Server
orderedReactivePolicies
array
otAssetBody
object
6 properties 4 required
otAssetEditBody
object
6 properties 4 required
otLocation
object
3 properties
outboundRestrictionMode
integer
'1' - No restrictions '2' - Internal Restricted '3' - External Restricted '4' - Internal and External Restricted '5' - No applicable
overridingProtectionPolicyBody
object
1 property
portsList
array
portSummary
object
2 properties
privateIpv4NetworksList
array
Collection of IPv4 subnets that are internal
privateIpv6NetworksList
array
Collection of IPv6 subnets that are internal
PrivilegedPorts
string
processSummary
object
2 properties
profileResponse
object
4 properties
profileUser
object
15 properties
protectionPoliciesList
object
1 property
protectionPolicy
object
13 properties
protectionPolicyBody
object
7 properties 3 required
protectionPolicyResponse
object
1 property
protectionPolicyUpdateBody
object
6 properties 3 required
protectionState
integer
'0' - Unspecified '1' - Unsegmented '2' - Unsegmenting '3' - Segmented '4' - Segmenting '5' - Learning until '6' - forcedunprotected '7' - Unsegmenting' - Due…
protocol
integer
'0' - HOPOPT '1' - ICMP '2' - IGMP '3' - GGP '4' - IPv4 '5' - ST '6' - TCP '7' - CBT '8' - EGP '9' - IGP '10' - BBN-RCC-MON '11' - NVP-II '12' - PUP '13' - ARG…
protocolTypeMFA
integer
6=TCP, 17=UDP
protocolAndPortAndProcess
object
3 properties
purdueLevel
integer
Purdue Level: '0' - Unspecified '1' - Level 0 '2' - Level 1 '3' - Level 2 '4' - Level 3 '5' - Level 4
queueAssetBody
object
1 property 1 required
queueAssetExtendBody
object
2 properties 1 required
queueAssetIdentityBody
object
1 property 1 required
queueAssetIdentityExtendBody
object
2 properties 1 required
queueExtendBody
object
3 properties 2 required
queueExtendIdentityBody
object
3 properties 2 required
queueExtendRPCBody
object
3 properties 2 required
reactivePoliciesStatistics
object
1 property
reactivePolicy
object
32 properties
reactivePolicyContext
integer
'0' - Unspecified '1' - Unmonitored Policies '2' - Default MFA Policies '3' - Senstive Tools and Processes
reactivePolicyDistribution
object
1 property
reactivePolicyInboundBody
object
22 properties 13 required
reactivePolicyItem
object
1 property
reactivePolicyList
object
1 property
reactivePolicyMethods
object
1 property
reactivePolicyOutboundBody
object
22 properties 12 required
reactivePolicyResponse
object
1 property
reactivePolicyState
integer
'1' - Enabled '2' - Disabled
requestedFilter
object
3 properties 1 required
role
integer
dictionary: '0' ROLEUNSPECIFIED '1' ROLEADMIN '2' ROLEVIEWER '3' ROLEREGULAR '4' ROLEMACHINEFULLACCESS '5' ROLEMACHINEREADONLY '6' ROLESELFSERVICE '7' ROLECLOU…
roleBody
object
1 property
roleCandidatesList
object
2 properties
rolesList
object
2 properties
rpcActivitiesList
object
2 properties
rpcActivity
object
16 properties
rpcFilter
object
7 properties
rpcFiltersList
object
1 property
rpcProtectionState
integer
'0' - Unspecified '1' - Unsegmented '2' - Unsegmenting '3' - Segmented '4' - Segmenting '5' - Learning until '6' - forcedunprotected '7' - Unsegmenting' - Due…
rpcProtocolsList
array
NULL - Any '1' - Rules RPC over SMB '2' - Rules RPC over TCP
rpcRule
object
25 properties
rpcRuleBody
object
13 properties 10 required
rpcRuleResponse
object
1 property
rpcRulesList
object
2 properties
rule
object
48 properties
ruleAction
integer
1 - Allow 2 - Block 3 - Force Block
ruleBody
object
16 properties 6 required
ruleClass
integer
'1' - Trivial '2' - Permissive '3' - Privileged '4' - Critical '5' - System '6' - Preventative '8' - Dangerous
ruleContext
integer
- '0' - Unspecified - '1' - Block - '2' - App Ring - '3' - Global RPC - '4' - Populare App - '5' - MS Cluster - '6' - Tag - '7' - Scanner - '8' - Popular Desti…
ruleDirection
integer
'1' - Inbound '2' - Outbound '3' - Both
ruleDistribution
object
1 property
ruleDuration
integer
'1' - Hour '2' - Day '3' - Week '4' - Month '5' - Never '6' - 4 hours '7' - 12 hours '8' - 8 hours
ruleFilter
object
2 properties
ruleItem
object
1 property
ruleMatch
object
2 properties
ruleResponse
object
1 property
ruleReviewApproveWithChanges
object
Mandatory object for rule review approvewithchanges / reject.
2 properties 2 required
ruleReviewBody
object
13 properties 8 required
ruleReviewMode
integer
1 - Apply Immediately 2 - Review 3 - Conditional Review
ruleReviewReason
object
Mandatory object for rule review approvewithchanges / reject. reason: { HUMANTRAFFICCOVEREDBYMFA = 1, TIGHTENRULESCOPE = 2, MISSINGPORTORPROCESS = 3, AFFECTEDE…
2 properties 1 required
rulesList
object
2 properties
ruleState
integer
'1' - Enabled '2' - Disabled '3' - Deleted By User '4' - Pending Review '5' - Pending Review Auto '6' - Rejected by User '7' - Excluded by User
ruleStatistics
object
4 properties
ruleStatisticsObject
object
3 properties
ruleStatisticsType
object
4 properties
ruleSuggestionType
integer
'0' - Unspecified '1' - Create '2' - Delete
savedFilter
object
3 properties 1 required
savedFilterBody
object
4 properties 4 required
savedFilterId
object
1 property
savedFilterPermission
string
'private' - only the creator can see the filter 'public' - all users can see the filter
savedFilterObject
object
8 properties
savedFiltersList
object
2 properties
savedFilterUpdateBody
object
3 properties 3 required
searchAssetsResponse
object
4 properties
searchGroupsResponse
object
4 properties
searchUsersResponse
object
4 properties
session
object
14 properties
sessionsList
object
1 property
setAssetType
object
1 property 1 required
setOSType
object
2 properties 2 required
setOutboundRestriction
object
2 properties 2 required
settingsActivities
object
1 property
settingsActivitiesBody
object
1 property 1 required
settingsAdForest
object
8 properties
settingsAdInfo
object
5 properties
settingsAdInfoBody
object
3 properties 3 required
settingsAdInfoResponse
object
1 property
settingsAdLinuxAutomationGroupsBody
object
1 property 1 required
settingsAdLinuxBody
object
2 properties 1 required
settingsAdSecondaryBody
object
1 property 1 required
getOuConfigs
object
1 property 1 required
ouConfig
object
3 properties 3 required
createOuConfigs
object
1 property 1 required
editOuConfigs
object
1 property 1 required
deleteOuConfigs
object
1 property 1 required
settingsAdSyncInfoResponse
object
settingsAdSyncInfoResponseDcItem
object
3 properties
settingsAdSyncInfoResponseDomainItem
object
1 property
settingsAdSyncInfoResponseForestItem
object
1 property
settingsAdWindowsAutomationGroupsBody
object
2 properties
settingsAiRuleReview
object
2 properties
settingsAiRuleReviewCleanup
object
1 property
settingsAiRuleReviewCleanupBody
object
1 property 1 required
settingsCyberarkConfig
object
5 properties
settingsCyberarkConfigBody
object
6 properties 6 required
settingsCyberarkConfigTest
object
2 properties
settingsAnsible
object
5 properties
settingsAnsibleBody
object
7 properties 7 required
settingsHypervisor
object
4 properties
settingsHypervisorConfig
object
2 properties
settingsHypervisorConfigWithPassword
object
3 properties 3 required
settingsHypervisorsList
object
1 property
settingsHypervisorCreateBody
object
3 properties 3 required
settingsHypervisorCreateResponse
object
1 property
settingsHypervisorUpdateBody
object
3 properties 3 required
settingsAntitamper
object
1 property
settingsAntitamperBody
object
1 property 1 required
settingsAssetsManagersBody
object
2 properties
sessionTtl
object
1 property
sessionTtlBody
object
1 property
allowedIps
object
1 property
allowedIpsBody
object
1 property 1 required
settingsAzureAd
object
3 properties
settingsAzureAdBody
object
3 properties
settingsClaroty
object
2 properties
settingsClarotyBody
object
2 properties 2 required
settingsBreakGlass
object
2 properties
settingsBreakGlassBody
object
2 properties 2 required
settingsBreakGlassMFA
object
1 property
settingsBreakGlassMFABody
object
1 property 1 required
settingsBreakGlassSwitches
object
2 properties
settingsBreakGlassSwitchesBody
object
2 properties 2 required
settingsClientSubnets
object
1 property
settingsClientSubnetsBody
object
1 property 1 required
settingsConnectClientAutoUpdate
object
1 property
settingsConnectClientAutoUpdateBody
object
1 property 1 required
settingsCustomerUserBody
object
1 property 1 required
settingsCustomerUserInviteBody
object
2 properties 2 required
settingsDay2Automation
object
1 property
settingsDay2AutomationBody
object
1 property 1 required
settingsPostureCheckDefinition
object
9 properties
settingsPostureCheckSettingInput
object
4 properties 3 required
settingsDomain
object
3 properties
settingsDomains
object
1 property
settingsEventsReceiverConfig
object
1 property
settingsEventsReceiverConfigBody
object
5 properties 1 required
settingsEventsReceiverConfigElastic
object
1 property
settingsEventsReceiverConfigElasticBody
object
2 properties 2 required
settingsEventsReceiverConfigMicrosoftSentinel
object
3 properties
settingsEventsReceiverConfigMicrosoftSentinelBody
object
4 properties 4 required
settingsEventsReceiverConfigSplunk
object
1 property
settingsEventsReceiverConfigSplunkBody
object
2 properties 2 required
settingsEventsReceiverExportIp
object
1 property
settingsEventsReceiverSyncStatus
object
4 properties
settingsEventsReceiverSyncState
object
4 properties
settingsFirewall
object
1 property
settingsFirewallBody
object
1 property 1 required
settingsFirewallIgnoredGPO
object
2 properties
settingsFirewallIgnoredGPOBody
object
2 properties
settingsFirewallIgnoredRules
object
2 properties
settingsFirewallIgnoredRulesBody
object
2 properties
settingsFirewallProfiles
object
3 properties
settingsFirewallProfilesBody
object
3 properties 3 required
settingsFirewallMode
object
1 property
firewallMode
string
settingsIdentityLogoff
object
1 property
settingsIdentityLogoffBody
object
1 property 1 required
settingsIdp
object
9 properties
settingsIdpBody
object
5 properties 5 required
settingsIdpDefaultApplication
object
1 property
settingsIdpDefaultApplicationBody
object
1 property 1 required
settingsIdpList
object
1 property
settingsInternalSubnets
object
1 property
settingsInternalSubnetsBody
object
2 properties 2 required
assetIpAlias
object
7 properties
assetIpAliasBody
object
2 properties 2 required
assetIpAliasItem
object
1 property
assetIpAliasList
object
2 properties
settingsJamfCredentials
object
3 properties
settingsJamfCredentialsBody
object
3 properties 3 required
settingsK8sApplicationsLabel
object
1 property
settingsK8sApplicationsLabelBody
object
1 property 1 required
settingsLearningConfig
object
3 properties
settingsLearningConfigBody
object
2 properties 2 required
settingsLearnWithBlockInbound
object
1 property
settingsLearnWithBlockInboundBody
settingsLinuxAutomationResponse
object
1 property
settingsLinuxSetup
object
1 property
settingsLinuxSetupBody
object
1 property 1 required
settingsLinuxUser
object
1 property
settingsLinuxUserBody
object
3 properties 3 required
settingsMfaAuthentication
object
3 properties
settingsMfaAuthenticationBody
object
3 properties 3 required
settingsMfaAuthenticationResponse
object
1 property
settingsMfaCache
object
4 properties
settingsMfaCacheBody
object
3 properties 3 required
settingsMfaCacheItem
object
1 property
settingsMfaCacheList
object
2 properties
settingsMfaDetection
object
1 property
settingsMfaDetectionBody
object
1 property 1 required
settingsMfaDetectionResponse
object
1 property
settingsNotification
array
settingsNotificationBody
array
settingsPrivilegedPorts
object
1 property
settingsPrivilegedPortsBody
object
2 properties 2 required
settingsProtectionAutomationResponse
object
2 properties
settingsPushNotifications
object
3 properties
silverfortMfaUnpairedAction
integer
Silverfort unpaired action (1) default behavior (2) allow (3) deny
silverfortExtraConfig
object
1 property 1 required
settingsPushNotificationsBody
object
5 properties 2 required
settingsPushNotificationsList
object
1 property
settingsTrustedInternet
object
1 property
settingsTrustedInternetAddresses
object
1 property
settingsTrustedInternetAddressesBody
object
1 property 1 required
settingsInternetAccessBody
object
2 properties 2 required
settingsUntrustedInternet
object
1 property
settingsSegmentConnectorUpdateRecoveryBody
object
3 properties 3 required
settingsWebhook
object
9 properties
settingsWebhookBody
object
7 properties 6 required
settingsWebhookItem
object
1 property
settingsWebhookTestBody
object
6 properties 5 required
settingsWebhookTriggersBody
object
1 property 1 required
settingsWebhookTestResponse
object
1 property
settingsWebhookTrigger
object
2 properties
settingsWebhooksList
object
1 property
settingsWebhooksSenderIp
object
1 property
settingsZpa
object
1 property
settingsZpaBody
object
5 properties 5 required
setUsersTypeBody
object
3 properties 3 required
setUserTypeBody
object
2 properties 1 required
simulateAccess
array
simulateAccessBody
object
4 properties 4 required
simulateAccessRecord
object
3 properties
simulateAccessRecordBody
object
4 properties
simulationParams
object
7 properties
simulationResponse
object
4 properties
source
integer
Possible asset sources: '0' - Unspecified '1' - Access portal '2' - SSP '3' - Active directory '4' - Custom '5' - System '6' - Ansible '7' - Manual OT/IoT '8'…
userCandidate
object
5 properties
srcUserCandidatesList
object
2 properties
srcUsersList
array
state
object
13 properties
switch
object
11 properties
switchBody
object
7 properties 7 required
switchesMonitoringBreakGlassBody
switchesNetworkBreakGlassBody
switchId
object
1 property
switchItem
object
2 properties
switchInterface
object
3 properties
switchInterfacesList
object
2 properties
switchVlan
object
3 properties
switchVlanList
object
2 properties
switchList
object
2 properties
switchSetBindingDirectionalBody
object
1 property
firewall
object
4 properties
firewallBody
object
3 properties 3 required
firewallId
object
1 property
firewallList
object
2 properties
switchMonitoringBreakGlassBody
object
1 property 1 required
switchNetworkBreakGlassBody
object
1 property 1 required
switchProtocolsList
object
3 properties
switchProtocolsListBody
array
switchRule
object
32 properties
switchRuleBody
object
14 properties 7 required
switchRuleItem
object
1 property
switchRulesList
object
2 properties
versionMaintenanceWindowList
object
1 property 1 required
versionMaintenanceWindow
object
4 properties 3 required
duration
object
2 properties 2 required
tempVersionMaintenanceWindowList
object
1 property 1 required
tempVersionMaintenanceWindow
object
2 properties 2 required
pilotGroupAssetList
object
2 properties
pilotGroupAsset
object
10 properties
pilotGroupModifyBody
object
1 property 1 required
pilotRolloutInfo
object
5 properties
systemHealthIssue
object
2 properties
systemHealthList
object
1 property
tagGroupBody
object
2 properties 1 required
tags
object
1 property
trafficType
integer
'1' - Internal '2' - External '3' - Both '4' - Any
pinDeploymentsClusterBody
object
2 properties 1 required
unpinDeploymentsClusterBody
object
1 property 1 required
user
userActiveState
integer
'1' - Active '2' - Deleted '3' - Disabled
userBasicInfo
userIdentityAnalysis
object
1 property
userIdResponse
object
1 property
userNetworkAnalysis
object
1 property
userProtectionState
integer
'1' - Unsegmented '3' - Segmented '5' - Learning until '6' - Learning done
userResponse
object
1 property
userRole
integer
'0' - Unspecified '1' - Admin '2' - Viewer '3' - Regular '4' - API-FullAccess '5' - API-ReadOnly '6' - SelfService '7' - CloudConnectorProvisioning '8' - JAMF…
userSimple
object
4 properties
usersProtectBody
object
1 property 1 required
usersQueueBody
object
2 properties 2 required
userStatistics
object
1 property
userSummary
object
3 properties
userType
integer
usersActivateBody
object
2 properties 1 required
userActivateBody
object
1 property
userConnectionEnrichment
object
9 properties
userViolation
object
7 properties
userViolationBody
object
2 properties 2 required
usersViolationList
object
2 properties
userViolationState
integer
'1' - FOUND '2' - IGNORED '3' - DEFERRED
validateResponse
object
1 property
identityProtectionCategory
integer
'0' - Unspecified '1' - Locally '2' - Network '3' - Batch '4' - Service '5' - RDP

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zero-networks-platform-openapi.yaml Raw ↑
#Security#Microsegmentation#Zero Trust#Segmentation
← Back to Z APIs
API Details
ID
zero-networks:zero-networks-platform-api
Base URL
https://portal.zeronetworks.com/api/v1
Docs
https://portal.zeronetworks.com/
Provider
Zero Networks
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zero-networks-zero-networks-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zero-networks-zero-networks-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Zero Networks Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.