Get API Details
Get the details of the running Product Name
Syntax: see Call Structure
Type = 'GET'
|
\'http://localhost:Port Number/api/v1/details' \ |
Returns:
|
{ "version": [version-number], "semver": "semver-variant", "guid" { "id": "service-id" "computerId": "computer-id }, "host": [ { "ip": "ip-address" "port": API-port "domainName": domain-name "hostName": host-name "adapterName": adapter-name "adapterType": "adapter-type }, { "ip": "ip-address" "port": API-port "domainName": domain-name "adapterName": adapter-name "adapterType": "adapter-type } ], "commitid": commitid-number, "branch": "branch-name", "install": "install-location", "logging": "logs-location", "settings": "settings-location", "documentation": "documentation-location", "cpu": { "brand": "brand-information", "arch": "CPU-architecture", "features": [CPU-features], "cores": cores-value }, "os": "OS-information" } } |
| Output | Description |
|---|---|
| version-number | Version number of API as an integer (Major,Minor,Revision,Build) |
| semver-variant | The full name of the API version |
| service-id | This is the id of the service as a unique 128-bit number |
| computer-id | This is the id of the computer as a unique 128-bit number |
| ip-address | The digital address for your internet-connected devices |
| API-port | The port number the API uses |
| domain-name | The name of the network domain |
| host-name | The name of the host computer |
| adapter-name | The name of the network adaptor |
| adapter-type | The type of network adaptor |
| commitid-variant | The number value of the Commit ID |
| branch-name | The branch of API installed |
| install-location | The location of install files |
| logs-location | The location of where logs are stored |
| settings-location | The location of API settings |
| documentation-location | The web address of API documentation |
| brand-information | The brand of the CPU |
| CPU-architecture | The architecture of the CPU |
| CPU-features | Features available on CPU |
| cores-value | How many cores the CPU has |
| os-information | Operating system running on local machine |
Example
curl -X 'GET' \
'http://localhost:43430/api/v1/details' \
-H 'accept: application/json'Returns
{
"version": [
0,
1,
0,
40
],
"semver": "0.1.0-master.40",
"guid": {
"id": "4ffdf7b6-a026-5afe-b49b-5d1aaac0ad1c",
"computerId": "35aea4bc-44d3-4e9e-9b3c-c33b965c5639"
},
"host": [
{
"ip": "10.167.111.95",
"port": 43430,
"domainName": "CBRX.LOCAL",
"hostName": "CBRXPC-011",
"adapterName": "Intel(R) Ethernet Controller (3) I225-V",
"adapterType": "Ethernet"
},
{
"ip": "172.30.224.1",
"port": 43430,
"hostName": "CBRXPC-011",
"adapterName": "Hyper-V Virtual Ethernet Adapter",
"adapterType": "Ethernet"
}
],
"commitid": 2590540970,
"branch": "master",
"install": "C:\\Program Files\\Cambrionix\\DeviceAPI\\bin",
"logging": "C:\\ProgramData\\Cambrionix\\DeviceAPI\\log",
"settings": "C:\\ProgramData\\Cambrionix\\DeviceAPI",
"cpu": {
"brand": "12th Gen Intel(R) Core(TM) i9-12900K",
"arch": "x64",
"features": [
"aes",
"avx",
"avx2",
"sse2",
"sse3",
"sse4_1",
"sse4_2",
"ssse3",
"tsc",
"vaes",
"vpclmulqdq"
],
"cores": 24
},
"os": "Windows 11 Pro 23H2 Build 22631.4037 64-bit"
}Errors
If there is an error in the API method then JSON-RPC Error Object a will be returned