ZeroKey

Open Protocol

Get Tools

Retrieve all Open Protocol tools

SecurityOAuth2 or ApiKey
Responses
200

List of Open Protocol tools

401

Unauthorized access, invalid credentials were used.

403

Access forbidden. Current token does not have the necessary authority for the operation.

500

Internal server error

get/modules/openprotocol/tools
Request samples 
Response samples 
application/json
[
  • {
    }
]
Add Tool
Add a new Open Protocol tool


SecurityOAuth2 or ApiKey 
Request 
Request Body schema: application/json
required
Name
required
string
Tool name


 
Host
required
string
Tool host IP address


 
Port
required
integer
Tool port number


 
Driver
string
Tool driver name


 
TraceSetting
integer
Trace setting value


 
IsActive
required
boolean
Tool active status


 
Responses 
201
Tool created successfully


400
Bad request


500
Internal server error


post/modules/openprotocol/tools
Request samples 
application/json
{
  • "Name": "ZK Kolver Tool",
  • "Host": "192.168.0.10",
  • "Port": 4545,
  • "Driver": "Test Driver",
  • "TraceSetting": 0,
  • "IsActive": true
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "Name": "string",
  • "Host": "string",
  • "Port": 0,
  • "Driver": "string",
  • "TraceSetting": 0,
  • "IsActive": true
}
Update Tool
Update an existing Open Protocol tool


SecurityOAuth2 or ApiKey 
Request 
path Parameters
toolId
required
string <uuid> 
The unique identifier of the tool


 
 Example:  a4ee47fa-7da1-4c61-8e0c-e9aad4c28542
Request Body schema: application/json
required
Name
required
string
Tool name


 
Host
required
string
Tool host IP address


 
Port
required
integer
Tool port number


 
Driver
string
Tool driver name


 
TraceSetting
integer
Trace setting value


 
IsActive
required
boolean
Tool active status


 
Responses 
200
Tool updated successfully


400
Bad request


404
Tool not found


500
Internal server error


put/modules/openprotocol/tools/{toolId}
Request samples 
application/json
{
  • "Name": "ZK Kolver Tool",
  • "Host": "192.168.0.10",
  • "Port": 4545,
  • "Driver": "Test Driver",
  • "TraceSetting": 0,
  • "IsActive": false
}
Response samples 
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "Name": "string",
  • "Host": "string",
  • "Port": 0,
  • "Driver": "string",
  • "TraceSetting": 0,
  • "IsActive": true
}
Delete Tool
Delete an Open Protocol tool


SecurityOAuth2 or ApiKey 
Request 
path Parameters
toolId
required
string <uuid> 
The unique identifier of the tool


 
 Example:  ced4ef13-fbb6-4edc-a90d-53841447a059
Responses 
204
Tool deleted successfully


404
Tool not found


500
Internal server error


delete/modules/openprotocol/tools/{toolId}
Request samples 
Toggle Tool
Toggle the enable/disable state of an Open Protocol tool


SecurityOAuth2 or ApiKey 
Request 
path Parameters
toolId
required
string <uuid> 
The unique identifier of the tool


 
 Example:  9b9f53c7-c93f-4a82-ad30-cd46938b741c
Request Body schema: application/json
required
Enable
required
boolean
Enable or disable the tool


 
Responses 
200
Tool toggle state updated successfully


400
Bad request


404
Tool not found


500
Internal server error


put/modules/openprotocol/tools/toggle/{toolId}
Request samples 
application/json
{
  • "Enable": true
}
➔ Next to Zone