Gateway Management API
Jan 1 2022 at 12:00 AM
The raptor gateway environment APIs, responsible for the manipulation and management of the driver services and core services.
APIs within Gateway Management
Service
API Calls
Online
Check if the Service Management Controller is online
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/service/online
URL Params
none
Data Params
none
Success Response
200 - Success
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Get
Get a list of the currently deployed raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/get
URL Params
none
Data Params
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
Success Response
200 - Returns a list of each service with an overview of information.
{
"services": [
{
"name": "collector",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753926Z"
},
{
"name": "identity",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753931Z"
},
{
"name": "cloud",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753933Z"
},
{
"name": "deployment",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753936Z"
},
{
"name": "devicestore",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753938Z"
},
{
"name": "ui",
"type": "core",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753941Z"
},
{
"name": "mqtt",
"type": "mqtt",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753944Z"
},
{
"name": "netclient",
"type": "netclient",
"status": false,
"version": "X.X.X.X",
"health": "Degraded",
"lastUpdated": "2021-03-17T10:08:43.5753946Z"
},
{
"name": "teltonika",
"type": "teltonika",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753949Z"
},
{
"name": "sam",
"type": "sam",
"status": true,
"version": "X.X.X.X",
"health": "Healthy",
"lastUpdated": "2021-03-17T10:08:43.5753953Z"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Deploy
Deploy a new service from the device store.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/deploy
URL Params
none
Data Params
{
"serviceInfo": {
"type": "ServiceSection",
"serviceName": "rams",
"description": "A device driver service for the rams driver.",
"serviceType": "rams",
"packageId": "IoTnxt.Raptor.Device.RAMS",
"requiresAuthentication": true
}
}
Success Response
200 - Each deployment step in the pipeline’s results.
{
"results": [
{
"name": "Deployment Step",
"isHandled": true,
"isSuccessful": true,
"message": "Deployment step to deploy driver",
"logEntries": [
"Started",
"Busy",
"Finished"
]
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Delete
Delete a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/delete
URL Params
none
Data Params
{
"services": [
"mqtt",
"rams"
]
}
Success Response
200 - A key value pair of the services and their deletion result.
{
"results": {
"mqtt": true,
"rams": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Restart
Restart a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/restart
URL Params
none
Data Params
{
"services": [
"mqtt",
"collector",
"sam"
]
}
Success Response
200 - A key value pair of the services and their restart result.
{
"results": {
"mqtt": true,
"collector": true,
"sam": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Toggle
Toggle a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/toggle
URL Params
none
Data Params
{
"services": {
"teltonika": false,
"quuppa": false,
"peoplesense": false
}
}
Success Response
200 - A key value pair of the services and their toggle result.
{
"results": {
"teltonika": true,
"quuppa": true,
"peoplesense": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Update
Update a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/update
URL Params
none
Data Params
{
"services": [
{
"serviceName": "ui",
"targetVersion": "4.0.10.1",
"configs": {
"LoggingOptions.json": "JSON-VALUE"
}
}
]
}
Success Response
200 - A key value pair of the services and their update result.
{
"results": {
"collector": true,
"ui": true,
"coap": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Exists
Check for an existing service.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/service/exists
URL Params
none
Data Params
{
"serviceName": "mqtt-service"
}
Success Response
200 - A response containing the result of the existing service check.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
CertificateAuthority
API Calls
Online
Check if the Certificate Management Controller is online
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/authority/online
URL Params
none
Data Params
none
Success Response
200 - Returns the assembly version of the API
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Get
Get a list of the raptor issuers/certificate authorities.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/authority/get
URL Params
none
Data Params
none
Success Response
200 - A list of the raptor issuers/certificate authorities.
{
"certificateAuthorities": {
"Root-Ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 1 (0x1)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=vraptor, O=IoT.nxt, OU=Virtual Raptor Root CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=vraptor, O=IoT.nxt, OU=Virtual Raptor Root CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e2:e5:7d:12:bc:54:ae:2e:98:d1:40:6e:ab:cb:\n 07:a8:59:c5:26:58:67:cb:cc:6c:72:44:35:1a:f0:\n 00:86:e4:da:47:11:09:ed:e3:e5:b5:fb:af:a1:0e:\n c2:3e:22:11:de:ed:ab:df:97:06:fb:22:31:39:d6:\n 28:1c:fc:6d:85:08:f9:97:47:c5:69:a1:4e:7a:56:\n 78:b9:19:20:f5:09:15:a3:1e:c5:1e:0e:ae:ad:09:\n f4:8d:df:ca:f3:df:56:8c:26:e7:e2:ae:a7:21:59:\n 06:89:37:ae:ef:84:cb:85:9d:3d:f9:ce:94:a1:4b:\n a3:d9:9c:23:d8:db:c1:cc:04:a6:5a:68:0c:be:c8:\n 12:9c:98:e5:db:c1:a4:38:0f:1c:1e:1b:1f:b0:a4:\n 2c:d3:f3:17:07:90:ca:7c:51:da:75:cd:6e:00:5c:\n 43:75:a5:30:a8:84:93:e1:16:04:ec:71:9f:5b:28:\n 11:59:dc:7d:f9:91:7a:b7:2c:07:83:19:d4:7f:e1:\n 91:98:f0:d1:e9:7e:d3:d5:4b:87:8c:83:00:6a:3f:\n 45:ee:cc:5d:d3:02:e5:a3:42:f6:e9:44:a0:9d:8f:\n cb:2d:70:12:c0:db:dc:d6:f0:ea:1d:69:0d:de:27:\n e2:ad:d6:01:86:ec:bd:1f:2d:38:91:ca:86:a7:df:\n 24:45\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE\n X509v3 Subject Key Identifier: \n 87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 1a:91:00:c5:58:2c:e4:be:c6:98:9c:9b:5d:3a:ac:07:0a:37:\n 49:70:00:1b:e7:10:a1:42:26:89:84:d2:08:38:ef:db:99:b5:\n 31:24:94:3c:7e:5c:50:cf:dc:a2:e5:95:aa:23:9b:45:75:70:\n 14:ef:b2:4d:59:9e:38:9a:c6:2c:36:c9:eb:a9:d8:13:6a:a0:\n 0c:aa:e0:f5:af:36:2f:68:3a:a8:72:59:33:51:ee:77:b5:4c:\n b9:b5:14:fb:95:ff:78:41:02:dc:4e:f2:8d:2f:e1:70:84:ff:\n 06:05:ef:67:d5:c6:61:b3:f3:41:8a:f7:77:7f:0f:8d:a9:e4:\n b7:07:34:95:1d:ce:0a:b1:a7:29:de:56:17:c2:62:61:49:6b:\n 8c:0a:93:5a:0c:02:d0:96:67:62:b9:b6:79:88:67:8b:8f:ef:\n c8:7e:96:e9:08:4c:60:04:c1:38:9f:73:6e:c7:cf:31:10:d4:\n b8:34:86:3c:12:6c:3d:34:1e:32:f0:24:58:b2:16:9d:bc:0e:\n 35:d5:a7:d8:1e:97:0d:10:f6:76:4c:ad:4e:bf:27:21:0b:f3:\n eb:89:84:a6:b2:dd:c9:29:b2:21:67:45:42:bc:bc:10:1b:11:\n 4d:d2:6c:d1:33:57:67:89:4f:ea:e1:9e:df:63:85:cd:5b:70:\n b2:12:55:f5\n-----BEGIN CERTIFICATE-----\nMIIDjDCCAnSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowVzEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEfMB0GA1UECwwWVmlydHVhbCBSYXB0b3IgUm9vdCBD\nQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOLlfRK8VK4umNFAbqvL\nB6hZxSZYZ8vMbHJENRrwAIbk2kcRCe3j5bX7r6EOwj4iEd7tq9+XBvsiMTnWKBz8\nbYUI+ZdHxWmhTnpWeLkZIPUJFaMexR4Orq0J9I3fyvPfVowm5+KupyFZBok3ru+E\ny4WdPfnOlKFLo9mcI9jbwcwEplpoDL7IEpyY5dvBpDgPHB4bH7CkLNPzFweQynxR\n2nXNbgBcQ3WlMKiEk+EWBOxxn1soEVncffmRercsB4MZ1H/hkZjw0el+09VLh4yD\nAGo/Re7MXdMC5aNC9ulEoJ2Pyy1wEsDb3Nbw6h1pDd4n4q3WAYbsvR8tOJHKhqff\nJEUCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\nVR0OBBYEFIeCiqp5JDmYXhDoOoQNmqJycKDkMB8GA1UdIwQYMBaAFIeCiqp5JDmY\nXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQAakQDFWCzkvsaYnJtdOqwH\nCjdJcAAb5xChQiaJhNIIOO/bmbUxJJQ8flxQz9yi5ZWqI5tFdXAU77JNWZ44msYs\nNsnrqdgTaqAMquD1rzYvaDqoclkzUe53tUy5tRT7lf94QQLcTvKNL+FwhP8GBe9n\n1cYRs/NBivd3fw+NqeS3BzSVHc4Ksacp3lYXwmJhSWuMCpNaDALQlmdiubZ5iGeL\nj+/IfpbpCExgBME4n3Nux88xENS4NIY8Emw9NB4y8CRYshadvA411afYHpcNEPZ2\nTK1OvychC/PriYSmst3JKbIhZ0VCvLwQGxFN0mzRM1dniU/q4Z7fY4XNW3CyElX1\n-----END CERTIFICATE-----",
"Signing-Ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 2 (0x2)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=vraptor, O=IoT.nxt, OU=Virtual Raptor Root CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=vraptor, O=IoT.nxt, OU=Virtual Raptor Signing CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e9:f2:b4:c3:20:7c:af:52:48:d5:57:4e:99:85:\n ea:ef:2f:01:29:d4:c4:a7:1a:10:43:2b:44:93:9d:\n a5:e7:90:7c:ec:7a:5e:0e:e8:0a:72:bd:da:7f:27:\n 9f:93:27:f0:0d:71:83:06:0c:31:47:f8:3a:a4:4b:\n 31:27:93:c3:f7:f7:dc:4e:90:03:1b:a9:3a:a9:98:\n 4c:18:91:88:43:a6:f2:3a:46:d2:b5:35:4b:3c:d5:\n e5:c1:83:a5:49:a5:f9:dc:d5:8b:1e:15:ea:7e:c1:\n 05:3d:30:d3:2e:34:35:69:7c:59:2a:5f:7f:fc:d6:\n 2f:bc:27:05:ca:1c:a4:13:71:38:c4:85:1c:de:5d:\n 5a:ae:14:ea:b4:ce:d5:bb:80:03:69:4b:51:1a:71:\n fc:2e:ae:ad:8b:e1:d9:7b:3d:fe:e2:09:d2:8d:ab:\n 4e:3b:ef:23:0e:82:32:82:18:ef:ab:41:ac:6b:75:\n 8e:92:97:9b:35:a8:1f:b0:a9:10:1e:d8:a0:bf:3f:\n 0a:78:24:78:77:30:79:5f:52:b8:50:14:bb:77:ed:\n a9:4f:c1:9a:2f:60:42:8d:e7:d9:d0:bc:ac:05:35:\n b2:08:39:2d:33:88:e3:24:01:07:60:4d:38:98:2a:\n 31:88:17:2f:b2:89:67:0e:28:bc:c0:f1:d1:6f:56:\n 97:4b\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE, pathlen:0\n X509v3 Subject Key Identifier: \n E8:66:49:1B:6E:88:C5:83:C5:B7:E7:A8:38:68:FB:A8:1A:B5:2D:D9\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 97:b3:b7:23:aa:fa:79:89:bb:07:e4:0b:77:b8:7e:2f:73:0a:\n 7c:ae:d1:46:7c:4c:d5:86:1e:af:b3:85:4d:55:70:e3:ea:92:\n d1:0f:a2:70:0e:30:b4:e7:74:1f:f2:67:c9:7c:38:db:77:7d:\n 20:e4:b3:6f:87:f8:55:4d:63:a3:e6:39:c5:3c:c1:8e:97:55:\n 07:56:23:ed:d7:69:49:60:35:05:ff:89:b5:ff:b2:24:9c:ce:\n 02:be:3f:d2:e2:c4:11:27:21:4d:03:e2:60:89:0e:1f:c8:32:\n 82:35:96:63:9c:6a:af:0d:7a:34:f4:71:90:1b:11:63:e3:e1:\n d8:d3:e3:b5:27:d3:64:80:f7:3a:41:9f:7d:ff:92:1c:51:c5:\n ee:30:50:f3:3a:de:30:c1:46:10:f4:33:fe:fc:e5:64:3f:51:\n 7a:e1:17:0f:ac:87:49:48:ec:62:73:4b:d4:52:1c:d6:43:bb:\n 8a:eb:84:c6:f1:dd:63:c0:f2:85:82:37:53:53:2c:ad:67:ea:\n 2a:dc:78:fa:1b:97:3b:17:4b:af:dc:eb:0a:71:86:ee:0a:bc:\n af:af:ef:b4:9f:6a:09:7f:ad:d3:f6:5f:03:c5:92:2c:f4:c7:\n e3:de:3d:18:2d:ad:9a:56:a8:85:1b:4f:65:dc:ee:19:ef:3f:\n c2:49:8c:4f\n-----BEGIN CERTIFICATE-----\nMIIDkjCCAnqgAwIBAgIBAjANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowWjEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEiMCAGA1UECwwZVmlydHVhbCBSYXB0b3IgU2lnbmlu\nZyBDQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOnytMMgfK9SSNVX\nTpmF6u8vASnUxKcaEEMrRJOdpeeQfOx6Xg7oCnK92n8nn5Mn8A1xgwYMMUf4OqRL\nMSeTw/f33E6QAxupOqmYTBiRiEOm8jpG0rU1SzzV5cGDpUml+dzVix4V6n7BBT0w\n0y40NWl8WSpff/zWL7wnBcocpBNxOMSFHN5dWq4U6rTO1buAA2lLURpx/C6urYvh\n2Xs9/uIJ0o2rTjvvIw6CMoIY76tBrGt1jwKXmzWoH7CpEB7YoL8/CngkeHcweV9S\nuFAUu3ftqU/Bmi9gQo3n2dC8rAU1sgg5LTOI4yQBB2BNOJgqMYgXL7KJZw4ovMDx\n0W9Wl0sCAwEAAaNmMGQwDgYDVR0PAQH/BAQDAgEGMBIGA1UdEwEB/wQIMAYBAf8C\nAQAwHQYDVR0OBBYEFOhmSRtuiMWDxbfnqDho+6gatS3ZMB8GA1UdIwQYMBaAFIeC\niqp5JDmYXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQCXs7cjqvp5ibsH\n5At3uH4vcwp8rtFGfEzVhh6vs4VNVXDj6pLRD6JwDjC053Qf8mfJfDjbd30g5LNv\nh/hVTVOj5jnFPMGOl1UHViPt12lJYDUF/4m1/7IknM4Cvj/S4sQRJyFNA+JgiQ4f\nyDKCNZZjnGqvDXo09HGQGxFj4+HY0+O1J9NkgPcqQZ99/5IcUcXuMFDzOt4wwUYQ\n9DP+/OVkP1F64RcPrIdJSOxic0vUUhzWQ7uK64TG8d1jwPKFgjdTUyytZ+oq3Hj6\nG5c7F0uv3OsKcYbuCryvr++0n2oJf63T9l8DxZIs9Mfj3j0YLa2aVqiFG09l3O4Z\n7z/CSYxP\n-----END CERTIFICATE-----\n"
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
GetTrusted
Get a list of the issuers/certificate authorities trusted by the raptor.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/authority/getTrusted
URL Params
none
Data Params
none
Success Response
200 - A list of the issuers/certificate authorities trusted by the raptor.
{
"certificateAuthorities": {
"trusted1-ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 1 (0x1)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=companya.rsa, O=IoT.nxt, OU=Company A CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=companya.rsa, O=IoT.nxt, OU=Company A CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e2:e5:7d:12:bc:54:ae:2e:98:d1:40:6e:ab:cb:\n 07:a8:59:c5:26:58:67:cb:cc:6c:72:44:35:1a:f0:\n 00:86:e4:da:47:11:09:ed:e3:e5:b5:fb:af:a1:0e:\n c2:3e:22:11:de:ed:ab:df:97:06:fb:22:31:39:d6:\n 28:1c:fc:6d:85:08:f9:97:47:c5:69:a1:4e:7a:56:\n 78:b9:19:20:f5:09:15:a3:1e:c5:1e:0e:ae:ad:09:\n f4:8d:df:ca:f3:df:56:8c:26:e7:e2:ae:a7:21:59:\n 06:89:37:ae:ef:84:cb:85:9d:3d:f9:ce:94:a1:4b:\n a3:d9:9c:23:d8:db:c1:cc:04:a6:5a:68:0c:be:c8:\n 12:9c:98:e5:db:c1:a4:38:0f:1c:1e:1b:1f:b0:a4:\n 2c:d3:f3:17:07:90:ca:7c:51:da:75:cd:6e:00:5c:\n 43:75:a5:30:a8:84:93:e1:16:04:ec:71:9f:5b:28:\n 11:59:dc:7d:f9:91:7a:b7:2c:07:83:19:d4:7f:e1:\n 91:98:f0:d1:e9:7e:d3:d5:4b:87:8c:83:00:6a:3f:\n 45:ee:cc:5d:d3:02:e5:a3:42:f6:e9:44:a0:9d:8f:\n cb:2d:70:12:c0:db:dc:d6:f0:ea:1d:69:0d:de:27:\n e2:ad:d6:01:86:ec:bd:1f:2d:38:91:ca:86:a7:df:\n 24:45\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE\n X509v3 Subject Key Identifier: \n 87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 1a:91:00:c5:58:2c:e4:be:c6:98:9c:9b:5d:3a:ac:07:0a:37:\n 49:70:00:1b:e7:10:a1:42:26:89:84:d2:08:38:ef:db:99:b5:\n 31:24:94:3c:7e:5c:50:cf:dc:a2:e5:95:aa:23:9b:45:75:70:\n 14:ef:b2:4d:59:9e:38:9a:c6:2c:36:c9:eb:a9:d8:13:6a:a0:\n 0c:aa:e0:f5:af:36:2f:68:3a:a8:72:59:33:51:ee:77:b5:4c:\n b9:b5:14:fb:95:ff:78:41:02:dc:4e:f2:8d:2f:e1:70:84:ff:\n 06:05:ef:67:d5:c6:61:b3:f3:41:8a:f7:77:7f:0f:8d:a9:e4:\n b7:07:34:95:1d:ce:0a:b1:a7:29:de:56:17:c2:62:61:49:6b:\n 8c:0a:93:5a:0c:02:d0:96:67:62:b9:b6:79:88:67:8b:8f:ef:\n c8:7e:96:e9:08:4c:60:04:c1:38:9f:73:6e:c7:cf:31:10:d4:\n b8:34:86:3c:12:6c:3d:34:1e:32:f0:24:58:b2:16:9d:bc:0e:\n 35:d5:a7:d8:1e:97:0d:10:f6:76:4c:ad:4e:bf:27:21:0b:f3:\n eb:89:84:a6:b2:dd:c9:29:b2:21:67:45:42:bc:bc:10:1b:11:\n 4d:d2:6c:d1:33:57:67:89:4f:ea:e1:9e:df:63:85:cd:5b:70:\n b2:12:55:f5\n-----BEGIN CERTIFICATE-----\nMIIDjDCCAnSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowVzEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEfMB0GA1UECwwWVmlydHVhbCBSYXB0b3IgUm9vdCBD\nQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOLlfRK8VK4umNFAbqvL\nB6hZxSZYZ8vMbHJENRrwAIbk2kcRCe3j5bX7r6EOwj4iEd7tq9+XBvsiMTnWKBz8\nbYUI+ZdHxWmhTnpWeLkZIPUJFaMexR4Orq0J9I3fyvPfVowm5+KupyFZBok3ru+E\ny4WdPfnOlKFLo9mcI9jbwcwEplpoDL7IEpyY5dvBpDgPHB4bH7CkLNPzFweQynxR\n2nXNbgBcQ3WlMKiEk+EWBOxxn1soEVncffmRercsB4MZ1H/hkZjw0el+09VLh4yD\nAGo/Re7MXdMC5aNC9ulEoJ2Pyy1wEsDb3Nbw6h1pDd4n4q3WAYbsvR8tOJHKhqff\nJEUCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\nVR0OBBYEFIeCiqp5JDmYXhDoOoQNmqJycKDkMB8GA1UdIwQYMBaAFIeCiqp5JDmY\nXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQAakQDFWCzkvsaYnJtdOqwH\nCjdJcAAb5xChQiaJhNIIOO/bmbUxJJQ8flxQz9yi5ZWqI5tFdXAU77JNWZ44msYs\nNsnrqdgTaqAMquD1rzYvaDqoclkzUe53tUy5tRT7lf94QQLcTvKNL+FwhP8GBe9n\n1cYRs/NBivd3fw+NqeS3BzSVHc4Ksacp3lYXwmJhSWuMCpNaDALQlmdiubZ5iGeL\nj+/IfpbpCExgBME4n3Nux88xENS4NIY8Emw9NB4y8CRYshadvA411afYHpcNEPZ2\nTK1OvychC/PriYSmst3JKbIhZ0VCvLwQGxFN0mzRM1dniU/q4Z7fY4XNW3CyElX1\n-----END CERTIFICATE-----",
"trusted2-ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 1 (0x1)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=companyb.rsa, O=IoT.nxt, OU=Company B CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=companyb.rsa, O=IoT.nxt, OU=Company B CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e2:e5:7d:12:bc:54:ae:2e:98:d1:40:6e:ab:cb:\n 07:a8:59:c5:26:58:67:cb:cc:6c:72:44:35:1a:f0:\n 00:86:e4:da:47:11:09:ed:e3:e5:b5:fb:af:a1:0e:\n c2:3e:22:11:de:ed:ab:df:97:06:fb:22:31:39:d6:\n 28:1c:fc:6d:85:08:f9:97:47:c5:69:a1:4e:7a:56:\n 78:b9:19:20:f5:09:15:a3:1e:c5:1e:0e:ae:ad:09:\n f4:8d:df:ca:f3:df:56:8c:26:e7:e2:ae:a7:21:59:\n 06:89:37:ae:ef:84:cb:85:9d:3d:f9:ce:94:a1:4b:\n a3:d9:9c:23:d8:db:c1:cc:04:a6:5a:68:0c:be:c8:\n 12:9c:98:e5:db:c1:a4:38:0f:1c:1e:1b:1f:b0:a4:\n 2c:d3:f3:17:07:90:ca:7c:51:da:75:cd:6e:00:5c:\n 43:75:a5:30:a8:84:93:e1:16:04:ec:71:9f:5b:28:\n 11:59:dc:7d:f9:91:7a:b7:2c:07:83:19:d4:7f:e1:\n 91:98:f0:d1:e9:7e:d3:d5:4b:87:8c:83:00:6a:3f:\n 45:ee:cc:5d:d3:02:e5:a3:42:f6:e9:44:a0:9d:8f:\n cb:2d:70:12:c0:db:dc:d6:f0:ea:1d:69:0d:de:27:\n e2:ad:d6:01:86:ec:bd:1f:2d:38:91:ca:86:a7:df:\n 24:45\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE\n X509v3 Subject Key Identifier: \n 87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 1a:91:00:c5:58:2c:e4:be:c6:98:9c:9b:5d:3a:ac:07:0a:37:\n 49:70:00:1b:e7:10:a1:42:26:89:84:d2:08:38:ef:db:99:b5:\n 31:24:94:3c:7e:5c:50:cf:dc:a2:e5:95:aa:23:9b:45:75:70:\n 14:ef:b2:4d:59:9e:38:9a:c6:2c:36:c9:eb:a9:d8:13:6a:a0:\n 0c:aa:e0:f5:af:36:2f:68:3a:a8:72:59:33:51:ee:77:b5:4c:\n b9:b5:14:fb:95:ff:78:41:02:dc:4e:f2:8d:2f:e1:70:84:ff:\n 06:05:ef:67:d5:c6:61:b3:f3:41:8a:f7:77:7f:0f:8d:a9:e4:\n b7:07:34:95:1d:ce:0a:b1:a7:29:de:56:17:c2:62:61:49:6b:\n 8c:0a:93:5a:0c:02:d0:96:67:62:b9:b6:79:88:67:8b:8f:ef:\n c8:7e:96:e9:08:4c:60:04:c1:38:9f:73:6e:c7:cf:31:10:d4:\n b8:34:86:3c:12:6c:3d:34:1e:32:f0:24:58:b2:16:9d:bc:0e:\n 35:d5:a7:d8:1e:97:0d:10:f6:76:4c:ad:4e:bf:27:21:0b:f3:\n eb:89:84:a6:b2:dd:c9:29:b2:21:67:45:42:bc:bc:10:1b:11:\n 4d:d2:6c:d1:33:57:67:89:4f:ea:e1:9e:df:63:85:cd:5b:70:\n b2:12:55:f5\n-----BEGIN CERTIFICATE-----\nMIIDjDCCAnSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowVzEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEfMB0GA1UECwwWVmlydHVhbCBSYXB0b3IgUm9vdCBD\nQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOLlfRK8VK4umNFAbqvL\nB6hZxSZYZ8vMbHJENRrwAIbk2kcRCe3j5bX7r6EOwj4iEd7tq9+XBvsiMTnWKBz8\nbYUI+ZdHxWmhTnpWeLkZIPUJFaMexR4Orq0J9I3fyvPfVowm5+KupyFZBok3ru+E\ny4WdPfnOlKFLo9mcI9jbwcwEplpoDL7IEpyY5dvBpDgPHB4bH7CkLNPzFweQynxR\n2nXNbgBcQ3WlMKiEk+EWBOxxn1soEVncffmRercsB4MZ1H/hkZjw0el+09VLh4yD\nAGo/Re7MXdMC5aNC9ulEoJ2Pyy1wEsDb3Nbw6h1pDd4n4q3WAYbsvR8tOJHKhqff\nJEUCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\nVR0OBBYEFIeCiqp5JDmYXhDoOoQNmqJycKDkMB8GA1UdIwQYMBaAFIeCiqp5JDmY\nXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQAakQDFWCzkvsaYnJtdOqwH\nCjdJcAAb5xChQiaJhNIIOO/bmbUxJJQ8flxQz9yi5ZWqI5tFdXAU77JNWZ44msYs\nNsnrqdgTaqAMquD1rzYvaDqoclkzUe53tUy5tRT7lf94QQLcTvKNL+FwhP8GBe9n\n1cYRs/NBivd3fw+NqeS3BzSVHc4Ksacp3lYXwmJhSWuMCpNaDALQlmdiubZ5iGeL\nj+/IfpbpCExgBME4n3Nux88xENS4NIY8Emw9NB4y8CRYshadvA411afYHpcNEPZ2\nTK1OvychC/PriYSmst3JKbIhZ0VCvLwQGxFN0mzRM1dniU/q4Z7fY4XNW3CyElX1\n-----END CERTIFICATE-----"
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
uploadTrusted
Upload issuers/certificate authorities that can be trusted by the raptor.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/authority/uploadTrusted
URL Params
none
Data Params
A key-value pair of the trusted issuers/certificate authorities.
{
"certificateAuthorities": {
"trusted1-ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 1 (0x1)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=companya.rsa, O=IoT.nxt, OU=Company A CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=companya.rsa, O=IoT.nxt, OU=Company A CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e2:e5:7d:12:bc:54:ae:2e:98:d1:40:6e:ab:cb:\n 07:a8:59:c5:26:58:67:cb:cc:6c:72:44:35:1a:f0:\n 00:86:e4:da:47:11:09:ed:e3:e5:b5:fb:af:a1:0e:\n c2:3e:22:11:de:ed:ab:df:97:06:fb:22:31:39:d6:\n 28:1c:fc:6d:85:08:f9:97:47:c5:69:a1:4e:7a:56:\n 78:b9:19:20:f5:09:15:a3:1e:c5:1e:0e:ae:ad:09:\n f4:8d:df:ca:f3:df:56:8c:26:e7:e2:ae:a7:21:59:\n 06:89:37:ae:ef:84:cb:85:9d:3d:f9:ce:94:a1:4b:\n a3:d9:9c:23:d8:db:c1:cc:04:a6:5a:68:0c:be:c8:\n 12:9c:98:e5:db:c1:a4:38:0f:1c:1e:1b:1f:b0:a4:\n 2c:d3:f3:17:07:90:ca:7c:51:da:75:cd:6e:00:5c:\n 43:75:a5:30:a8:84:93:e1:16:04:ec:71:9f:5b:28:\n 11:59:dc:7d:f9:91:7a:b7:2c:07:83:19:d4:7f:e1:\n 91:98:f0:d1:e9:7e:d3:d5:4b:87:8c:83:00:6a:3f:\n 45:ee:cc:5d:d3:02:e5:a3:42:f6:e9:44:a0:9d:8f:\n cb:2d:70:12:c0:db:dc:d6:f0:ea:1d:69:0d:de:27:\n e2:ad:d6:01:86:ec:bd:1f:2d:38:91:ca:86:a7:df:\n 24:45\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE\n X509v3 Subject Key Identifier: \n 87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 1a:91:00:c5:58:2c:e4:be:c6:98:9c:9b:5d:3a:ac:07:0a:37:\n 49:70:00:1b:e7:10:a1:42:26:89:84:d2:08:38:ef:db:99:b5:\n 31:24:94:3c:7e:5c:50:cf:dc:a2:e5:95:aa:23:9b:45:75:70:\n 14:ef:b2:4d:59:9e:38:9a:c6:2c:36:c9:eb:a9:d8:13:6a:a0:\n 0c:aa:e0:f5:af:36:2f:68:3a:a8:72:59:33:51:ee:77:b5:4c:\n b9:b5:14:fb:95:ff:78:41:02:dc:4e:f2:8d:2f:e1:70:84:ff:\n 06:05:ef:67:d5:c6:61:b3:f3:41:8a:f7:77:7f:0f:8d:a9:e4:\n b7:07:34:95:1d:ce:0a:b1:a7:29:de:56:17:c2:62:61:49:6b:\n 8c:0a:93:5a:0c:02:d0:96:67:62:b9:b6:79:88:67:8b:8f:ef:\n c8:7e:96:e9:08:4c:60:04:c1:38:9f:73:6e:c7:cf:31:10:d4:\n b8:34:86:3c:12:6c:3d:34:1e:32:f0:24:58:b2:16:9d:bc:0e:\n 35:d5:a7:d8:1e:97:0d:10:f6:76:4c:ad:4e:bf:27:21:0b:f3:\n eb:89:84:a6:b2:dd:c9:29:b2:21:67:45:42:bc:bc:10:1b:11:\n 4d:d2:6c:d1:33:57:67:89:4f:ea:e1:9e:df:63:85:cd:5b:70:\n b2:12:55:f5\n-----BEGIN CERTIFICATE-----\nMIIDjDCCAnSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowVzEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEfMB0GA1UECwwWVmlydHVhbCBSYXB0b3IgUm9vdCBD\nQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOLlfRK8VK4umNFAbqvL\nB6hZxSZYZ8vMbHJENRrwAIbk2kcRCe3j5bX7r6EOwj4iEd7tq9+XBvsiMTnWKBz8\nbYUI+ZdHxWmhTnpWeLkZIPUJFaMexR4Orq0J9I3fyvPfVowm5+KupyFZBok3ru+E\ny4WdPfnOlKFLo9mcI9jbwcwEplpoDL7IEpyY5dvBpDgPHB4bH7CkLNPzFweQynxR\n2nXNbgBcQ3WlMKiEk+EWBOxxn1soEVncffmRercsB4MZ1H/hkZjw0el+09VLh4yD\nAGo/Re7MXdMC5aNC9ulEoJ2Pyy1wEsDb3Nbw6h1pDd4n4q3WAYbsvR8tOJHKhqff\nJEUCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\nVR0OBBYEFIeCiqp5JDmYXhDoOoQNmqJycKDkMB8GA1UdIwQYMBaAFIeCiqp5JDmY\nXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQAakQDFWCzkvsaYnJtdOqwH\nCjdJcAAb5xChQiaJhNIIOO/bmbUxJJQ8flxQz9yi5ZWqI5tFdXAU77JNWZ44msYs\nNsnrqdgTaqAMquD1rzYvaDqoclkzUe53tUy5tRT7lf94QQLcTvKNL+FwhP8GBe9n\n1cYRs/NBivd3fw+NqeS3BzSVHc4Ksacp3lYXwmJhSWuMCpNaDALQlmdiubZ5iGeL\nj+/IfpbpCExgBME4n3Nux88xENS4NIY8Emw9NB4y8CRYshadvA411afYHpcNEPZ2\nTK1OvychC/PriYSmst3JKbIhZ0VCvLwQGxFN0mzRM1dniU/q4Z7fY4XNW3CyElX1\n-----END CERTIFICATE-----",
"trusted2-ca": "Certificate:\n Data:\n Version: 3 (0x2)\n Serial Number: 1 (0x1)\n Signature Algorithm: sha256WithRSAEncryption\n Issuer: DC=companyb.rsa, O=IoT.nxt, OU=Company B CA\n Validity\n Not Before: Jul 17 12:15:40 2020 GMT\n Not After : Jul 17 12:15:40 2030 GMT\n Subject: DC=companyb.rsa, O=IoT.nxt, OU=Company B CA\n Subject Public Key Info:\n Public Key Algorithm: rsaEncryption\n RSA Public-Key: (2048 bit)\n Modulus:\n 00:e2:e5:7d:12:bc:54:ae:2e:98:d1:40:6e:ab:cb:\n 07:a8:59:c5:26:58:67:cb:cc:6c:72:44:35:1a:f0:\n 00:86:e4:da:47:11:09:ed:e3:e5:b5:fb:af:a1:0e:\n c2:3e:22:11:de:ed:ab:df:97:06:fb:22:31:39:d6:\n 28:1c:fc:6d:85:08:f9:97:47:c5:69:a1:4e:7a:56:\n 78:b9:19:20:f5:09:15:a3:1e:c5:1e:0e:ae:ad:09:\n f4:8d:df:ca:f3:df:56:8c:26:e7:e2:ae:a7:21:59:\n 06:89:37:ae:ef:84:cb:85:9d:3d:f9:ce:94:a1:4b:\n a3:d9:9c:23:d8:db:c1:cc:04:a6:5a:68:0c:be:c8:\n 12:9c:98:e5:db:c1:a4:38:0f:1c:1e:1b:1f:b0:a4:\n 2c:d3:f3:17:07:90:ca:7c:51:da:75:cd:6e:00:5c:\n 43:75:a5:30:a8:84:93:e1:16:04:ec:71:9f:5b:28:\n 11:59:dc:7d:f9:91:7a:b7:2c:07:83:19:d4:7f:e1:\n 91:98:f0:d1:e9:7e:d3:d5:4b:87:8c:83:00:6a:3f:\n 45:ee:cc:5d:d3:02:e5:a3:42:f6:e9:44:a0:9d:8f:\n cb:2d:70:12:c0:db:dc:d6:f0:ea:1d:69:0d:de:27:\n e2:ad:d6:01:86:ec:bd:1f:2d:38:91:ca:86:a7:df:\n 24:45\n Exponent: 65537 (0x10001)\n X509v3 extensions:\n X509v3 Key Usage: critical\n Certificate Sign, CRL Sign\n X509v3 Basic Constraints: critical\n CA:TRUE\n X509v3 Subject Key Identifier: \n 87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n X509v3 Authority Key Identifier: \n keyid:87:82:8A:AA:79:24:39:98:5E:10:E8:3A:84:0D:99:62:72:70:A0:E4\n\n Signature Algorithm: sha256WithRSAEncryption\n 1a:91:00:c5:58:2c:e4:be:c6:98:9c:9b:5d:3a:ac:07:0a:37:\n 49:70:00:1b:e7:10:a1:42:26:89:84:d2:08:38:ef:db:99:b5:\n 31:24:94:3c:7e:5c:50:cf:dc:a2:e5:95:aa:23:9b:45:75:70:\n 14:ef:b2:4d:59:9e:38:9a:c6:2c:36:c9:eb:a9:d8:13:6a:a0:\n 0c:aa:e0:f5:af:36:2f:68:3a:a8:72:59:33:51:ee:77:b5:4c:\n b9:b5:14:fb:95:ff:78:41:02:dc:4e:f2:8d:2f:e1:70:84:ff:\n 06:05:ef:67:d5:c6:61:b3:f3:41:8a:f7:77:7f:0f:8d:a9:e4:\n b7:07:34:95:1d:ce:0a:b1:a7:29:de:56:17:c2:62:61:49:6b:\n 8c:0a:93:5a:0c:02:d0:96:67:62:b9:b6:79:88:67:8b:8f:ef:\n c8:7e:96:e9:08:4c:60:04:c1:38:9f:73:6e:c7:cf:31:10:d4:\n b8:34:86:3c:12:6c:3d:34:1e:32:f0:24:58:b2:16:9d:bc:0e:\n 35:d5:a7:d8:1e:97:0d:10:f6:76:4c:ad:4e:bf:27:21:0b:f3:\n eb:89:84:a6:b2:dd:c9:29:b2:21:67:45:42:bc:bc:10:1b:11:\n 4d:d2:6c:d1:33:57:67:89:4f:ea:e1:9e:df:63:85:cd:5b:70:\n b2:12:55:f5\n-----BEGIN CERTIFICATE-----\nMIIDjDCCAnSgAwIBAgIBATANBgkqhkiG9w0BAQsFADBXMSIwIAYKCZImiZPyLGQB\nGRYSdDAwMDAwMDAyOC12cmFwdG9yMRAwDgYDVQQKDAdJb1Qubnh0MR8wHQYDVQQL\nDBZWaXJ0dWFsIFJhcHRvciBSb290IENBMB4XDTIwMDcxNzEyMTU0MFoXDTMwMDcx\nNzEyMTU0MFowVzEiMCAGCgmSJomT8ixkARkWEnQwMDAwMDAwMjgtdnJhcHRvcjEQ\nMA4GA1UECgwHSW9ULm54dDEfMB0GA1UECwwWVmlydHVhbCBSYXB0b3IgUm9vdCBD\nQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAOLlfRK8VK4umNFAbqvL\nB6hZxSZYZ8vMbHJENRrwAIbk2kcRCe3j5bX7r6EOwj4iEd7tq9+XBvsiMTnWKBz8\nbYUI+ZdHxWmhTnpWeLkZIPUJFaMexR4Orq0J9I3fyvPfVowm5+KupyFZBok3ru+E\ny4WdPfnOlKFLo9mcI9jbwcwEplpoDL7IEpyY5dvBpDgPHB4bH7CkLNPzFweQynxR\n2nXNbgBcQ3WlMKiEk+EWBOxxn1soEVncffmRercsB4MZ1H/hkZjw0el+09VLh4yD\nAGo/Re7MXdMC5aNC9ulEoJ2Pyy1wEsDb3Nbw6h1pDd4n4q3WAYbsvR8tOJHKhqff\nJEUCAwEAAaNjMGEwDgYDVR0PAQH/BAQDAgEGMA8GA1UdEwEB/wQFMAMBAf8wHQYD\nVR0OBBYEFIeCiqp5JDmYXhDoOoQNmqJycKDkMB8GA1UdIwQYMBaAFIeCiqp5JDmY\nXhDoOoQNmWJycKDkMA0GCSqGSIb3DQEBCwUAA4IBAQAakQDFWCzkvsaYnJtdOqwH\nCjdJcAAb5xChQiaJhNIIOO/bmbUxJJQ8flxQz9yi5ZWqI5tFdXAU77JNWZ44msYs\nNsnrqdgTaqAMquD1rzYvaDqoclkzUe53tUy5tRT7lf94QQLcTvKNL+FwhP8GBe9n\n1cYRs/NBivd3fw+NqeS3BzSVHc4Ksacp3lYXwmJhSWuMCpNaDALQlmdiubZ5iGeL\nj+/IfpbpCExgBME4n3Nux88xENS4NIY8Emw9NB4y8CRYshadvA411afYHpcNEPZ2\nTK1OvychC/PriYSmst3JKbIhZ0VCvLwQGxFN0mzRM1dniU/q4Z7fY4XNW3CyElX1\n-----END CERTIFICATE-----"
}
}
Success Response
200 - A key-value pair of the result of each trusted issuer/certificate authority’s upload.
{
"results": {
"trusted1-ca": true,
"trusted2-ca": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
removeTrusted
Remove issuers/certificate authorities trusted by the raptor.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/authority/removeTrusted
URL Params
none
Data Params
A list of the trusted issuers/certificate authorities to be removed.
{
"issuers": [
"trusted1-ca"
]
}
Success Response
200 - A key-value pair of the result of each trusted issuer/certificate authority’s removal.
{
"results": {
"trusted1-ca": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
ExternalCertificate
API Calls
Online
Check if the Certificate Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/external/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
get
CGet the certificates trusted by the raptor that were issued by trusted CAs (e.g. let's encrypt).
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/external/get
URL Params
none
Data Params
none
Success Response
200 - A list of trusted certificates that was uploaded to the raptor.
{
"results": [
{
"subjectName": "public.rsa",
"domain": "rsa",
"dateIssued": "2021-03-17T10:08:43.3931896Z",
"publicKey": "-----BEGIN CERTIFICATE-----\n MIIDtzCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBTMRswGQYKCZImiZPyLGQBGRYLZGV2LXZy\n YXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxIjAgBgNVBAsMGVZpcnR1YWwgUmFwdG9yIFNpZ25pbmcg\n Q0EwHhcNMjAwNjMwMTUwMDQ2WhcNMjIwNjMwMTUwMDQ2WjBMMRswGQYKCZImiZPyLGQBGRYLZGV2\n LXZyYXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxGzAZBgNVBAMMEmRldm9wcy5kZXYtdnJhcHRvcjCC\n ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMG7zpdiCnZGT8nIkbSBvRtM0q3YaIsmLNvb\n 493oSQC8GBLf2SXA+XNtDzEkQw86WWrfHdoLNf+PsADEOM4Gk+ws6Ga6T/i6+Zo2D2ZOC2OgU+sQ\n 88NEYPRzurh+zcLNpBUXEOE25K+OWgovvf0QEwf/7HXL4x7DHIfty0sXVlJu7h+ij/FAVf8jDnSk\n XM+MpN8+RTPAZLClJfnEchZSrPMM9Ftym/BkumDbVn0XLBt2ZVqUM67KcTLRc+Ym72NSgF6QGNkD\n GYAdnImTVpFaWI+4tmpitjL4Ikb92kkA44nWT+MzfETlJ7TT7fuT0BYuc+MUgqvm7pdybu9QbLfk\n wEMCAwEAAaOBnDCBmTAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEF\n BQcDAQYIKwYBBQUHAwIwHQYDVR0OBBYEFNkA+q0fpXjINwEs+Xt4wyWOQ14ZMB8GA1UdIwQYMBaA\n FBP/g736JRkW5Pv7yP/BEBbbwmWrMB0GA1UdEQQWMBSCEmRldm9wcy5kZXYtdnJhcHRvcjANBgkq\n hkiG9w0BAQsFAAOCAQEAlqMRyQGYZ6AO/prbzI8QDjtbFa0tcm+rOiH/jfYejz6DKrEiAqS4xxap\n JWFzFDf5ig6LEDWMOOtA4LvUG9ZOC6ryZZlTm9g7EEUXT3LLCBAilodgrRP8R4pLfk9UdGITjzEA\n ZZaQ8TFBQ76BjpYnD7qSKv7NPJkS+mWaR/yFDUEAYJiSieqagRbEYi1BtYkmHoke3VY2oKpcCxSi\n B5fRIHereA2jbDNCLZCjQmVpQByvZZ6wtBBrvltNy0QvP4P6q7q0CCb0m2QkQ8aavBRvWYxtRy5w\n 0av4cJTHYge3ivOAZZxEoSfiD6dnH6nw2DFfjmARu2uClxPdrARdoGBqXQ==\n -----END CERTIFICATE-----\n ",
"expiresOn": "2023-03-17T10:08:43.3931897Z",
"certificateType": "Rsa",
"issuer": "LetsEncrypt"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Upload
Upload a certificate that can be trusted by the raptor that was issued by trusted CAs (e.g. let's encrypt).
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/external/upload
URL Params
none
Data Params
The default certificate information of the trusted certificate.
{
"domain": "public.rsa",
"certificateType": "Rsa",
"publicKey": "-----BEGIN CERTIFICATE-----\nMIIFYzCCBEugAwIBAgISA3UfbI2fI5PlRJuLNCSJomq+MA0GCSqGSIb3DQEBCwUA\nMEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD\nExpMZXQncyBFbmNyeXB0IEF1dGhvcml0eSBYMzAeFw0yMDA4MjEwNjU4MjNaFw0y\nMDExMTkwNjU4MjNaMCAxHjAcBgNVBAMTjoisDi12cmFwdG9yLmlvdG54dC5pbzCC\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK4Tz3Z9oYx5eNDW1F/PH6JB\n7mU2F5w3+k+5CCauKt1wCB+bsSbvwsACC253bXMHsV8NAv2rnjO3dO5QcE7waohG\nOdX0+k4XHIT0AOiq/1za7OYogIqiqqICkSdqAVJ7K+7PYkP0dercoJ6w9v4Lfttv\nNx0VqekDaZ3+H1HaI3SRp5lPBvsXvftuKrwW6TZuwfFyzA8j83FtViD8sCtrP9FX\nKgKILmnKlxBfNkB1kImPqyNiockjLapjwqunlNAt1wxqB6arlyk/YsE9MrXNGOvo\nOKebpkXU4M/2DbVrtwmHp9lcAf97D6rTE/L3dFJYGl8Ta71yih+QZqHK5zh6zuEC\nAwEAAaOCAmswggJnMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcD\nAQYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQUkhPdeOQyFzVJJVVl\nqjoqmw83BVQwHwYDVR0jBBgwFoAUqEpqYwR93brm0Tm3pkVl7/Oo7KEwbwYIKwYB\nBQUHAQEEYzBhMC4GCCsGAQUFBzABhiJodHRwOi8vb2NzcC5pbnQteDMubGV0c2Vu\nY3J5cHQub3JnMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2Vu\nY3J5cHQub3JnLzAgBgNVHREEGTAXghVxYTItdnJhcHRvci5pb3RueHQuaW8wTAYD\nVR0gBEUwQzAIBgZngQwBAgEwNwYLKwYBBAGC3xMBAQEwKDAmBggrBgEFBQcCARYa\naHR0cDovL2Nwcy5sZXRzZW5jcnlwdC5vcmcwggEFBgorBgEEAdZ5AgQCBIH2BIHz\nAPEAdgBep3P531bA57U2SH3QSeAyepGaDIShEhKEGHWWgXFFWAAAAXQQBp/9AAAE\nAwBHMEUCIHkI04ZT+drSMrQ4vbAV+OK8Bt6O2KY029ngXa4hAF5wAiEAx3bdUVW0\nHWJdyn1iYhuuLzJ5lEnoKQ4OE47pKEMG8hcAdwCyHgXMi6LNiiBOh2b5K7mKJSBn\na9r6cOeySVMt74uQXgAAAXQQBp/yAAAEAwBIMEYCIQC/Zp23jqx0WFmDdCx/O+Na\nSoUvhtj1gZZIwd6YdZiIdQIhAJk66GwaphZskrVmnMC8B34WI1gvAUr+eQ9KH+BG\nA2OqMA0GCSqGSIb3DQEBCwUAA4IBAQAceGdv8XZoos2T8hiQejm+y7VcDZuiN1X8\nsK4ZOZNuJe0pqInyKnuqwu9+hpVWA4M3DUarpHStjLy+Zhbm7NCMrE3T97nWgsUx\nO1xvIH+Pzt4aXEfIwgDbKCdPBNO/P4v5wFgnIvWeuR9x8UUIczKaC0xcmqzMq64K\n3bGGD+dkE9qauxtwHKQg+aaDa0rMrrBA8PaTzdg/WSbhwBV3n5kjvTxyWNfSMznB\nShJVpJI8M9Ne/3X6OGwMYFRYg7kbUTarjySFcFfVw44hPXdSygfVd7gs7NYjInVW\nZ32s8dC90aNjW3IgSZkM7OehOPRDvE9z3pyAP84tGBQA8+WksDI2\n-----END CERTIFICATE-----",
"privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvAIBADANBgkqhkiG9w0BAQEFAASCBKYwggSiAgEAAoIBAQCuE892faGMeXjQ\n1tRfzx+iQe5lNhecN/pPuQgmrirdcAgfm7Em78LAAgtud21zB7FfDQL9q54zt3Tu\nUHBO8GqIRjnV9PpOFxyE9ADoqv9c2uzmKICKoqqiApEnagFSeyvuz2JD9HXq3KCe\nsPb+C37bbzcdFanpA2md/h9R2iN0kaeZTwb7F737biq8Fuk2bsHxcswPI/NxbVYg\n/LAraz/RVyoCiC5pypcQXzZAdZCJj6sjYqHJIy2qY8Krp5TQLdcMagemq5cpP2LB\nPTK1zRjr6Dinm6ZF1ODP9g21a7cJh6fZXAH/ew+q0xPy93RSWBpfE2u9coofkGah\nyuc4es7hAgMBAAECggEAN/1JMixQRJVhZZJjdnlxDEg2fDk8uNNMYE38MCy+vsBk\n7H2wKfzd39IIiTxCaMglpZPSzXJgjPPJ2UjoBovPSAuGWKnVxD4svxqYHD27qssD\nfTezuGN/jGJU+59d04CobcQoMAE12BekVcZHewiJgdywlls8biTZ2KY+vp3x33Dd\n6OoeQCmLrQ6cAo7hZ6RB1uPZJnGqqNoHJWisdiwC3I5SsfqeShTcYjz4skPFkZkZ\n4EFcxHV4dWp5uBamfrDpDCNjTEoB5oEOVQSfXIzCEzhBb/EEUHBABJEk1jHFY7mR\ngN7+fsoK/BX798n4ijYIboyK5wzTp9w9Aj9C0UDdnQKBgQDYAVQSc69AEGrR10D7\nqaVG1sotCuJC7U1uzthEvfIJxOpZsErboLXeu859nD68bpOnGNw2vVbN3xFFCXyD\nb7h8h+zapA+XgbQj8OnhV5LpcCLoYoaFTXGlva92PxUk/2ltCBVipyJv90v4rytP\nBhl8c3geefaiCE9d5RRgjJzcPwKBgQDOTxldHc/MIqH7TdpceV8ioKfqkNjOTQy3\np/0LbWPGg1UapMirX4p4YwaDrNfrRe6zB/KOGR5Hl06Q/EQUPSLuGbTqRDABQFml\n5di5Rtv4hDUWEdN1dL5PpZoqzHlJCxcV+hzdPNHOqeKazM21WE8/V4BSn9kxvZo9\nO7IUjXwM3wKBgHSoywIoLpc4BqkMS1Ff/x5yNMD85tRkm3RkDFOcDpOOIU+NMfDK\nLE9+OPiIIS3dvqr5dz2tJquLdSVHCVNnTEkdlCNFhhI6f9MFcxs8E+E1qfS9+Y8X\nE3EDMDd5vG697u9u9TXRtHyqIALQgGBul+cp6c7z6er69/prFYVLjBA7AoGACp49\nkvJO2JXLunBmVa4VfGXCXqs3zV5f0i/+MRFfOj9WKPnkLhXLvahzFGHX9w7xWxuE\nm1Wlnk+mRoYFRvlii9ic3BXIVrgmJQiwX9DKz36WcN1YAcqRZO4EAkHl2CGO/Z2S\n0LwpnDZYKFl0GOpDoeHyA86gUhQNFSu2XaJuiQcCgYADUNeeTQw7VYIVAhmzJveZ\nQmk4J1CN3zXJ4tyUGn2m32IDMFCmj1fpz94baN+JXms4BwIDZjttJT8oFpAhJYna\nKvz3w7Dxi56PUxUZnnmdxH9HhifMclLanyQVGGJRjE7/DDvUwTYHTTQhTAMpaBsm\nWQF/FjG8oQwF01m4pFgArg==\n-----END PRIVATE KEY-----"
}
Success Response
200 - Complete certificate details.
{
"subjectName": "public.rsa",
"domain": "rsa",
"dateIssued": "2021-03-17T10:08:43.4031711Z",
"publicKey": "-----BEGIN CERTIFICATE-----\nMIIFYzCCBEugAwIBAgISA3UfbI2fI5PlRJuLNCSJomq+MA0GCSqGSIb3DQEBCwUA\nMEoxCzAJBgNVBAYTAlVTMRYwFAYDVQQKEw1MZXQncyBFbmNyeXB0MSMwIQYDVQQD\nExpMZXQncyBFbmNyeXB0IEF1dGhvcml0eSBYMzAeFw0yMDA4MjEwNjU4MjNaFw0y\nMDExMTkwNjU4MjNaMCAxHjAcBgNVBAMTjoisDi12cmFwdG9yLmlvdG54dC5pbzCC\nASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAK4Tz3Z9oYx5eNDW1F/PH6JB\n7mU2F5w3+k+5CCauKt1wCB+bsSbvwsACC253bXMHsV8NAv2rnjO3dO5QcE7waohG\nOdX0+k4XHIT0AOiq/1za7OYogIqiqqICkSdqAVJ7K+7PYkP0dercoJ6w9v4Lfttv\nNx0VqekDaZ3+H1HaI3SRp5lPBvsXvftuKrwW6TZuwfFyzA8j83FtViD8sCtrP9FX\nKgKILmnKlxBfNkB1kImPqyNiockjLapjwqunlNAt1wxqB6arlyk/YsE9MrXNGOvo\nOKebpkXU4M/2DbVrtwmHp9lcAf97D6rTE/L3dFJYGl8Ta71yih+QZqHK5zh6zuEC\nAwEAAaOCAmswggJnMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEFBQcD\nAQYIKwYBBQUHAwIwDAYDVR0TAQH/BAIwADAdBgNVHQ4EFgQUkhPdeOQyFzVJJVVl\nqjoqmw83BVQwHwYDVR0jBBgwFoAUqEpqYwR93brm0Tm3pkVl7/Oo7KEwbwYIKwYB\nBQUHAQEEYzBhMC4GCCsGAQUFBzABhiJodHRwOi8vb2NzcC5pbnQteDMubGV0c2Vu\nY3J5cHQub3JnMC8GCCsGAQUFBzAChiNodHRwOi8vY2VydC5pbnQteDMubGV0c2Vu\nY3J5cHQub3JnLzAgBgNVHREEGTAXghVxYTItdnJhcHRvci5pb3RueHQuaW8wTAYD\nVR0gBEUwQzAIBgZngQwBAgEwNwYLKwYBBAGC3xMBAQEwKDAmBggrBgEFBQcCARYa\naHR0cDovL2Nwcy5sZXRzZW5jcnlwdC5vcmcwggEFBgorBgEEAdZ5AgQCBIH2BIHz\nAPEAdgBep3P531bA57U2SH3QSeAyepGaDIShEhKEGHWWgXFFWAAAAXQQBp/9AAAE\nAwBHMEUCIHkI04ZT+drSMrQ4vbAV+OK8Bt6O2KY029ngXa4hAF5wAiEAx3bdUVW0\nHWJdyn1iYhuuLzJ5lEnoKQ4OE47pKEMG8hcAdwCyHgXMi6LNiiBOh2b5K7mKJSBn\na9r6cOeySVMt74uQXgAAAXQQBp/yAAAEAwBIMEYCIQC/Zp23jqx0WFmDdCx/O+Na\nSoUvhtj1gZZIwd6YdZiIdQIhAJk66GwaphZskrVmnMC8B34WI1gvAUr+eQ9KH+BG\nA2OqMA0GCSqGSIb3DQEBCwUAA4IBAQAceGdv8XZoos2T8hiQejm+y7VcDZuiN1X8\nsK4ZOZNuJe0pqInyKnuqwu9+hpVWA4M3DUarpHStjLy+Zhbm7NCMrE3T97nWgsUx\nO1xvIH+Pzt4aXEfIwgDbKCdPBNO/P4v5wFgnIvWeuR9x8UUIczKaC0xcmqzMq64K\n3bGGD+dkE9qauxtwHKQg+aaDa0rMrrBA8PaTzdg/WSbhwBV3n5kjvTxyWNfSMznB\nShJVpJI8M9Ne/3X6OGwMYFRYg7kbUTarjySFcFfVw44hPXdSygfVd7gs7NYjInVW\nZ32s8dC90aNjW3IgSZkM7OehOPRDvE9z3pyAP84tGBQA8+WksDI2\n-----END CERTIFICATE-----",
"expiresOn": "2023-03-17T10:08:43.4031713Z",
"certificateType": "Rsa",
"issuer": "LetsEncrypt",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Remove
Remove a trusted certificate that was uploaded to the raptor that was issued by trusted CAs (e.g. let's encrypt).
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/external/remove
URL Params
none
Data Params
The certificate type of the trusted certificate to remove.
{
"certificateType": "Rsa"
}
Success Response
200 - The result of the trusted certificate removal.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
InternalCertificate
API Calls
Online
Check if the Certificate Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/internal/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
get
Get a list of certificates issued by the raptor.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/internal/get
URL Params
none
Data Params
none
Success Response
200 - A list of certificates issued by the raptor.
{
"results": [
{
"subjectName": "mqtt-service.iotnxt.io",
"domain": "iotnxt.io",
"dateIssued": "2021-03-17T10:08:43.4995171Z",
"publicKey": "-----BEGIN CERTIFICATE-----\n MIIDtzCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBTMRswGQYKCZImiZPyLGQBGRYLZGV2LXZy\n YXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxIjAgBgNVBAsMGVZpcnR1YWwgUmFwdG9yIFNpZ25pbmcg\n Q0EwHhcNMjAwNjMwMTUwMDQ2WhcNMjIwNjMwMTUwMDQ2WjBMMRswGQYKCZImiZPyLGQBGRYLZGV2\n LXZyYXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxGzAZBgNVBAMMEmRldm9wcy5kZXYtdnJhcHRvcjCC\n ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMG7zpdiCnZGT8nIkbSBvRtM0q3YaIsmLNvb\n 493oSQC8GBLf2SXA+XNtDzEkQw86WWrfHdoLNf+PsADEOM4Gk+ws6Ga6T/i6+Zo2D2ZOC2OgU+sQ\n 88NEYPRzurh+zcLNpBUXEOE25K+OWgovvf0QEwf/7HXL4x7DHIfty0sXVlJu7h+ij/FAVf8jDnSk\n XM+MpN8+RTPAZLClJfnEchZSrPMM9Ftym/BkumDbVn0XLBt2ZVqUM67KcTLRc+Ym72NSgF6QGNkD\n GYAdnImTVpFaWI+4tmpitjL4Ikb92kkA44nWT+MzfETlJ7TT7fuT0BYuc+MUgqvm7pdybu9QbLfk\n wEMCAwEAAaOBnDCBmTAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEF\n BQcDAQYIKwYBBQUHAwIwHQYDVR0OBBYEFNkA+q0fpXjINwEs+Xt4wyWOQ14ZMB8GA1UdIwQYMBaA\n FBP/g736JRkW5Pv7yP/BEBbbwmWrMB0GA1UdEQQWMBSCEmRldm9wcy5kZXYtdnJhcHRvcjANBgkq\n hkiG9w0BAQsFAAOCAQEAlqMRyQGYZ6AO/prbzI8QDjtbFa0tcm+rOiH/jfYejz6DKrEiAqS4xxap\n JWFzFDf5ig6LEDWMOOtA4LvUG9ZOC6ryZZlTm9g7EEUXT3LLCBAilodgrRP8R4pLfk9UdGITjzEA\n ZZaQ8TFBQ76BjpYnD7qSKv7NPJkS+mWaR/yFDUEAYJiSieqagRbEYi1BtYkmHoke3VY2oKpcCxSi\n B5fRIHereA2jbDNCLZCjQmVpQByvZZ6wtBBrvltNy0QvP4P6q7q0CCb0m2QkQ8aavBRvWYxtRy5w\n 0av4cJTHYge3ivOAZZxEoSfiD6dnH6nw2DFfjmARu2uClxPdrARdoGBqXQ==\n -----END CERTIFICATE-----\n ",
"expiresOn": "2023-03-17T10:08:43.4995173Z",
"certificateType": "Rsa",
"serviceId": "mqtt-service",
"issuer": "IoT.nxt"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Issue
Issue/Generate certificates signed by the raptor's certificate authority.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/internal/issue
URL Params
none
Data Params
A list of service names to issue the certificates for.
{
"services": [
"mqtt-service"
]
}
Success Response
200 - A list of certificates issued by the raptor for the given service names in the request.
{
"results": [
{
"subjectName": "mqtt-service.iotnxt.io",
"domain": "iotnxt.io",
"dateIssued": "2021-03-17T10:08:43.5083323Z",
"publicKey": "-----BEGIN CERTIFICATE-----\n MIIDtzCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBTMRswGQYKCZImiZPyLGQBGRYLZGV2LXZy\n YXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxIjAgBgNVBAsMGVZpcnR1YWwgUmFwdG9yIFNpZ25pbmcg\n Q0EwHhcNMjAwNjMwMTUwMDQ2WhcNMjIwNjMwMTUwMDQ2WjBMMRswGQYKCZImiZPyLGQBGRYLZGV2\n LXZyYXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxGzAZBgNVBAMMEmRldm9wcy5kZXYtdnJhcHRvcjCC\n ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMG7zpdiCnZGT8nIkbSBvRtM0q3YaIsmLNvb\n 493oSQC8GBLf2SXA+XNtDzEkQw86WWrfHdoLNf+PsADEOM4Gk+ws6Ga6T/i6+Zo2D2ZOC2OgU+sQ\n 88NEYPRzurh+zcLNpBUXEOE25K+OWgovvf0QEwf/7HXL4x7DHIfty0sXVlJu7h+ij/FAVf8jDnSk\n XM+MpN8+RTPAZLClJfnEchZSrPMM9Ftym/BkumDbVn0XLBt2ZVqUM67KcTLRc+Ym72NSgF6QGNkD\n GYAdnImTVpFaWI+4tmpitjL4Ikb92kkA44nWT+MzfETlJ7TT7fuT0BYuc+MUgqvm7pdybu9QbLfk\n wEMCAwEAAaOBnDCBmTAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEF\n BQcDAQYIKwYBBQUHAwIwHQYDVR0OBBYEFNkA+q0fpXjINwEs+Xt4wyWOQ14ZMB8GA1UdIwQYMBaA\n FBP/g736JRkW5Pv7yP/BEBbbwmWrMB0GA1UdEQQWMBSCEmRldm9wcy5kZXYtdnJhcHRvcjANBgkq\n hkiG9w0BAQsFAAOCAQEAlqMRyQGYZ6AO/prbzI8QDjtbFa0tcm+rOiH/jfYejz6DKrEiAqS4xxap\n JWFzFDf5ig6LEDWMOOtA4LvUG9ZOC6ryZZlTm9g7EEUXT3LLCBAilodgrRP8R4pLfk9UdGITjzEA\n ZZaQ8TFBQ76BjpYnD7qSKv7NPJkS+mWaR/yFDUEAYJiSieqagRbEYi1BtYkmHoke3VY2oKpcCxSi\n B5fRIHereA2jbDNCLZCjQmVpQByvZZ6wtBBrvltNy0QvP4P6q7q0CCb0m2QkQ8aavBRvWYxtRy5w\n 0av4cJTHYge3ivOAZZxEoSfiD6dnH6nw2DFfjmARu2uClxPdrARdoGBqXQ==\n -----END CERTIFICATE-----\n ",
"privateKey": "-----PRIVATE KEY-----\n MIIDtzCCAp+gAwIBAgIBATANBgkqhkiG9w0BAQsFADBTMRswGQYKCZImiZPyLGQBGRYLZGV2LXZy\n YXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxIjAgBgNVBAsMGVZpcnR1YWwgUmFwdG9yIFNpZ25pbmcg\n Q0EwHhcNMjAwNjMwMTUwMDQ2WhcNMjIwNjMwMTUwMDQ2WjBMMRswGQYKCZImiZPyLGQBGRYLZGV2\n LXZyYXB0b3IxEDAOBgNVBAoMB0lvVC5ueHQxGzAZBgNVBAMMEmRldm9wcy5kZXYtdnJhcHRvcjCC\n ASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMG7zpdiCnZGT8nIkbSBvRtM0q3YaIsmLNvb\n 493oSQC8GBLf2SXA+XNtDzEkQw86WWrfHdoLNf+PsADEOM4Gk+ws6Ga6T/i6+Zo2D2ZOC2OgU+sQ\n 88NEYPRzurh+zcLNpBUXEOE25K+OWgovvf0QEwf/7HXL4x7DHIfty0sXVlJu7h+ij/FAVf8jDnSk\n XM+MpN8+RTPAZLClJfnEchZSrPMM9Ftym/BkumDbVn0XLBt2ZVqUM67KcTLRc+Ym72NSgF6QGNkD\n GYAdnImTVpFaWI+4tmpitjL4Ikb92kkA44nWT+MzfETlJ7TT7fuT0BYuc+MUgqvm7pdybu9QbLfk\n wEMCAwEAAaOBnDCBmTAOBgNVHQ8BAf8EBAMCBaAwCQYDVR0TBAIwADAdBgNVHSUEFjAUBggrBgEF\n BQcDAQYIKwYBBQUHAwIwHQYDVR0OBBYEFNkA+q0fpXjINwEs+Xt4wyWOQ14ZMB8GA1UdIwQYMBaA\n FBP/g736JRkW5Pv7yP/BEBbbwmWrMB0GA1UdEQQWMBSCEmRldm9wcy5kZXYtdnJhcHRvcjANBgkq\n hkiG9w0BAQsFAAOCAQEAlqMRyQGYZ6AO/prbzI8QDjtbFa0tcm+rOiH/jfYejz6DKrEiAqS4xxap\n JWFzFDf5ig6LEDWMOOtA4LvUG9ZOC6ryZZlTm9g7EEUXT3LLCBAilodgrRP8R4pLfk9UdGITjzEA\n ZZaQ8TFBQ76BjpYnD7qSKv7NPJkS+mWaR/yFDUEAYJiSieqagRbEYi1BtYkmHoke3VY2oKpcCxSi\n B5fRIHereA2jbDNCLZCjQmVpQByvZZ6wtBBrvltNy0QvP4P6q7q0CCb0m2QkQ8aavBRvWYxtRy5w\n 0av4cJTHYge3ivOAZZxEoSfiD6dnH6nw2DFfjmARu2uClxPdrARdoGBqXQ==\n -----END PRIVATE KEY-----\n ",
"expiresOn": "2023-03-17T10:08:43.5083327Z",
"certificateType": "Rsa",
"password": "UHusawGEsd",
"serviceId": "mqtt-service",
"issuer": "IoT.nxt",
"digitalSignature": "&@SA2isa29n$!na"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Revoke
Revoke/Remove certificates signed by the raptor's certificate authority.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/certificate/internal/revoke
URL Params
none
Data Params
A list of service id’s to revoke the certificates for.
{
"services": [
"mqtt-service"
]
}
Success Response
200 - A key-value pair of the result of each certificate’s removal.
{
"results": {
"mqtt-service": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Connection
API Calls
online
Check if the Connection Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/connection/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Get
Get the service connection info.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/connection/get
URL Params
none
Data Params
The request for service connection info with a service type and name filter.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
Success Response
200 - A list of services with their connection info.
{
"services": {
"mqtt-service": {
"serviceName": "mqtt-service",
"ports": [
{
"internalPort": 6000,
"isExposed": false,
"protocol": "Tcp",
"usage": "Rpc",
"urls": [
"mqtt-service.vraptor:6000"
]
},
{
"internalPort": 8000,
"isExposed": false,
"protocol": "Tcp",
"usage": "Http",
"urls": [
"mqtt-service.vraptor:8000"
]
},
{
"internalPort": 8001,
"isExposed": false,
"protocol": "Tcp",
"usage": "Http",
"urls": [
"mqtt-service.vraptor:8001"
]
},
{
"internalPort": 12945,
"isExposed": true,
"externalPort": 8213,
"protocol": "Tcp",
"usage": "Other",
"active": true,
"urls": [
"mqtt-service.vraptor:12945",
"vraptor.iotnxt.io:8213"
]
}
]
}
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
ExternalPort
API Calls
online
Check if the Connection Management Controller is online
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Get
Get service(s) exposed ports.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/get
URL Params
none
Data Params
The request for exposed service ports with a service type and name filter.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
Success Response
200 - A list of exposed service ports with their exposed port info for each service.
{
"results": {
"mqtt-service": [
{
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
}
]
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
expose
Expose a list of ports to a service(s) for external communication/connection.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/expose
URL Params
none
Data Params
A list of service ports to be exposed.
{
"ports": [
{
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
{
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
}
]
}
Success Response
200 - A list of exposal results of the service ports that were exposed.
{
"results": [
{
"exposedServicePort": {
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
"result": true
},
{
"exposedServicePort": {
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
},
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
remove
Remove a list of exposed ports from a service(s) restricting external communication/connection.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/remove
URL Params
none
Data Params
A list of exposed service ports to be removed.
{
"ports": [
{
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
{
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
}
]
}
Success Response
200 - A list of removal results of the exposed service ports that were removed.
{
"results": [
{
"exposedServicePort": {
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
"result": true
},
{
"exposedServicePort": {
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
},
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
toggle
Toggle a list of exposed ports from a service(s) restricting external communication/connection.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/toggle
URL Params
none
Data Params
A list of exposed service ports to be toggled.
{
"ports": [
{
"exposedServicePort": {
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
"result": true
},
{
"exposedServicePort": {
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
},
"result": true
}
]
}
Success Response
200 - A list of toggle results of the exposed service ports that were toggled.
{
"results": [
{
"exposedServicePort": {
"serviceName": "collector",
"internalPort": 8001,
"externalPort": 6443,
"protocol": "Tcp",
"active": true
},
"result": true
},
{
"exposedServicePort": {
"serviceName": "mqtt-service",
"internalPort": 12945,
"externalPort": 8213,
"protocol": "Tcp",
"active": true
},
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
checkAvailable
Check if an exposed service port is available for a given service.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/checkAvailable
URL Params
none
Data Params
The exposed service port info.
{
"serviceName": "mqtt-service",
"externalPort": 8213,
"protocol": "Tcp"
}
Success Response
200 - If the exposed service port is available.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
getAvailable
Get the lowest available exposed service port.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/external/getAvailable
URL Params
none
Data Params
The service and port type info.
{
"serviceName": "mqtt-service",
"protocol": "Tcp"
}
Success Response
200 - AThe lowest available exposed service port for that service.
{
"result": 8213,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
InternalPort
API Calls
online
Check if the Connection Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Get
Get service(s) exposed ports.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/get
URL Params
none
Data Params
The request for service ports with a service type and name filter.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
Success Response
200 - A list of service ports with their port info for each service.
{
"results": {
"mqtt-service": [
{
"serviceName": "mqtt-service",
"port": 6000,
"protocol": "Tcp",
"usage": "Rpc"
},
{
"serviceName": "mqtt-service",
"port": 8000,
"protocol": "Tcp",
"usage": "Http"
},
{
"serviceName": "mqtt-service",
"port": 8001,
"protocol": "Tcp",
"usage": "Http"
},
{
"serviceName": "mqtt-service",
"port": 12945,
"protocol": "Tcp",
"usage": "Other"
}
]
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
add
Add a list of ports to a service(s) for inner communication/connection.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/add
URL Params
none
Data Params
A list of service ports to be added.
{
"ports": [
{
"serviceName": "collector",
"port": 6000,
"protocol": "Tcp",
"usage": "Rpc"
},
{
"serviceName": "collector",
"port": 8001,
"protocol": "Tcp",
"usage": "Http"
},
{
"serviceName": "mqtt-service",
"port": 12945,
"protocol": "Tcp",
"usage": "Other"
}
]
}
Success Response
200 - A list of addition results of the service ports that were added.
{
"results": [
{
"servicePort": {
"serviceName": "collector",
"port": 6000,
"protocol": "Tcp",
"usage": "Rpc"
},
"result": true
},
{
"servicePort": {
"serviceName": "collector",
"port": 8001,
"protocol": "Tcp",
"usage": "Http"
},
"result": true
},
{
"servicePort": {
"serviceName": "mqtt-service",
"port": 12945,
"protocol": "Tcp",
"usage": "Other"
},
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
remove
Remove a list of ports from a service restricting communication/connection.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/remove
URL Params
none
Data Params
A list of service ports to be removed.
{
"ports": [
{
"serviceName": "collector",
"port": 6000,
"protocol": "Tcp",
"usage": "Rpc"
},
{
"serviceName": "collector",
"port": 8001,
"protocol": "Tcp",
"usage": "Http"
},
{
"serviceName": "mqtt-service",
"port": 12945,
"protocol": "Tcp",
"usage": "Other"
}
]
}
Success Response
200 - A list of deletion results of the service ports that were removed.
{
"results": [
{
"servicePort": {
"serviceName": "collector",
"port": 6000,
"protocol": "Tcp",
"usage": "Rpc"
},
"result": true
},
{
"servicePort": {
"serviceName": "collector",
"port": 8001,
"protocol": "Tcp",
"usage": "Http"
},
"result": true
},
{
"servicePort": {
"serviceName": "mqtt-service",
"port": 12945,
"protocol": "Tcp",
"usage": "Other"
},
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
checkAvailable
Check if a service port is available for a given service.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/checkAvailable
URL Params
none
Data Params
The service port info.
{
"serviceName": "mqtt-service",
"internalPort": 12945,
"protocol": "Tcp",
"usage": "Other"
}
Success Response
200 - If the service port is available.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
getAvailable
Get the lowest available service port.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/port/internal/getAvailable
URL Params
none
Data Params
The service and port type info.
{
"serviceName": "mqtt-service",
"protocol": "Tcp",
"usage": "Other"
}
Success Response
200 - The lowest available service port for that service.
{
"result": 12945,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Authorization
API Calls
online
Check if the Authorization Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/authorization/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
RequestAccessToken
Request a Bearer token from the server to use for API calls. This method does not require authorization.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/authorization/RequestAccessToken
URL Params
none
Data Params
The body of the request must contain the ServiceId, Scope and Signature.
{
"serviceId": "my-cert-serviceid",
"signature": "N@!#)(NJ)I(LSAJDSADIJdoasks"
}
Success Response
200 - The token request results are in the response body.
{
"token": "N@(#UIH)*HFDJSAJHDIJ(_)!U@J)(DJSOIAJDOIUJHSO*AYD*&YO*QWHJEDKJHAWEO",
"tokenType": "RaptorRPC",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Validate
Validate if authentication token is valid
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/authorization/Validate
URL Params
none
Data Params
none
Success Response
200 - Authorized access token.
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Config
API Calls
online
Check if the Config Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/config/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
get
Get a list of config options sections.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/get
URL Params
none
Data Params
A request with the config option section’s definitions.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"versions": [
0,
1
],
"configOnly": false
}
]
}
Success Response
200 - A list of config options sections with their versions.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"configs": [
{
"version": 0,
"configContents": "{\\\"selectedClientConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"}},\\\"selectedBrokerConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000002-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"}},\\\"mqttProperties\\\":{\\\"DemoDevice\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}},\\\"devices\\\":{\\\"broker-config\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000024-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"},\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"},\\\"DemoDeviceProperties\\\":{\\\"deviceType\\\":\\\"DefaultProperties\\\",\\\"propertyMaps\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}}}}",
"lastUpdateUtc": "2021-03-17T10:08:43.2356646Z"
}
],
"meta": ""
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
sections/get
Get a list of config options sections names.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/sections/get
URL Params
none
Data Params
A request of the services to retrieve their config options sections for.
{
"services": [
"mqtt-service"
]
}
Success Response
200 - A response list of services with their config options sections names.
{
"services": {
"mqtt-service": [
{
"optionsSection": "DevicesOptions.json",
"currentVersion": 0,
"lastUpdatedUtc": "2021-03-17T10:08:43.2424231Z"
}
]
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
versions/get
Get a list of config versions for a config options section.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/versions/get
URL Params
none
Data Params
A request with the list of services and their config options sections to retrieve versions for.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json"
}
]
}
Success Response
200 - A response list of the services with their config options section’s versions.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"versions": [
{
"version": 0,
"lastUpdatedUtc": "2021-03-17T10:08:43.2502434Z"
}
]
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
current/version/get
Get the current version of a config options section.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/current/version/get
URL Params
none
Data Params
The config options section to get the current version for.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json"
}
Success Response
200 - A response of the current version of the specified config options section.
{
"version": 0,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Update
Update a list of config options sections.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/update
URL Params
none
Data Params
A request list of config options sections with the modified config contents.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"configContents": "{\\\"selectedClientConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"}},\\\"selectedBrokerConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000002-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"}},\\\"mqttProperties\\\":{\\\"DemoDevice\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}},\\\"devices\\\":{\\\"broker-config\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000024-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"},\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"},\\\"DemoDeviceProperties\\\":{\\\"deviceType\\\":\\\"DefaultProperties\\\",\\\"propertyMaps\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}}}}"
}
]
}
Success Response
200 - A response list of config options sections and their update results.
{
"optionsSections": [
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"result": true
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Rollback
Rollback a config options section to a specific version.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/rollback
URL Params
none
Data Params
A request with a config options section version to rollback to.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"targetVersion": 0
}
Success Response
200 - A response of the result of the rollback.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Reset
Reset a config options section to default/initial config.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/reset
URL Params
none
Data Params
A request with a config options section to reset.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"removeConfigs": true
}
Success Response
200 - A response of the result of the reset.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
overwrite
Overwrite a config options section with modified config contents.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/overwrite
URL Params
none
Data Params
A request with a config options section and version to overwrite.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"configContents": "{\\\"selectedClientConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"}},\\\"selectedBrokerConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000002-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"}},\\\"mqttProperties\\\":{\\\"DemoDevice\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}},\\\"devices\\\":{\\\"broker-config\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000024-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"},\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"},\\\"DemoDeviceProperties\\\":{\\\"deviceType\\\":\\\"DefaultProperties\\\",\\\"propertyMaps\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}}}}",
"targetVersion": 1
}
Success Response
200 - A response of the result of the overwrite.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
config/version/compare
Check if a modified config contents has changed from a given version of the config options section.</remarks>
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/version/compare
URL Params
none
Data Params
A request with a config options section and modified config contents to compare against a version.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"version": 0,
"targetVersion": 1
}
Success Response
200 - A response of the result of the comparison.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
config/compare
Check if a version has changed from another given version of the config options section.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/compare
URL Params
none
Data Params
A request with a config options section version to compare against another version.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"modifiedConfigContents": "{\\\"selectedClientConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"}},\\\"selectedBrokerConfiguration\\\":{\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000002-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"}},\\\"mqttProperties\\\":{\\\"DemoDevice\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}},\\\"devices\\\":{\\\"broker-config\\\":{\\\"deviceName\\\":\\\"DemoBroker\\\",\\\"deviceType\\\":\\\"TcpBroker\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":null,\\\"make\\\":null,\\\"model\\\":null,\\\"host\\\":\\\"t000000024-vraptor.iotnxt.io\\\",\\\"port\\\":\\\"8883\\\",\\\"useTls\\\":true,\\\"validateCertificate\\\":false,\\\"username\\\":\\\"vraptor\\\",\\\"password\\\":\\\"lbTjfOHZVeDJo\\\"},\\\"DemoDevice\\\":{\\\"deviceName\\\":\\\"DemoDevice\\\",\\\"deviceType\\\":\\\"MqttTcp\\\",\\\"groupName\\\":\\\"Mqtt\\\",\\\"enabled\\\":true,\\\"debug\\\":true,\\\"propertiesDeviceName\\\":\\\"DemoDeviceProperties\\\",\\\"make\\\":null,\\\"model\\\":null,\\\"brokerDeviceName\\\":\\\"DemoBroker\\\",\\\"publishId\\\":\\\"12345\\\",\\\"subscribeId\\\":\\\"12345\\\"},\\\"DemoDeviceProperties\\\":{\\\"deviceType\\\":\\\"DefaultProperties\\\",\\\"propertyMaps\\\":{\\\"Prop\\\":{\\\"name\\\":\\\"Prop\\\",\\\"dataType\\\":\\\"STRING\\\",\\\"subscribeTopic\\\":\\\"user\\/telemetry\\/12345\\\",\\\"subscribeFormat\\\":\\\"Raw\\\"}}}}}",
"targetVersion": 0
}
Success Response
200 - A response of the result of the comparison.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
config/version/delete
Delete a version of a config options section.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/version/delete
URL Params
none
Data Params
A request of the config options section version to delete.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"targetVersion": 0,
"deleteRunningConfig": true
}
Success Response
200 - A response of the result of the deletion.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
config/delete
Delete all versions of a config options section.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/delete
URL Params
none
Data Params
A request of the config options section to delete.
{
"serviceName": "mqtt-service",
"optionsSection": "DevicesOptions.json",
"deleteRunningConfig": false
}
Success Response
200 - A response of the result of the deletion.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
config/delete/all
Delete all versions of all config options sections of a service.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/delete/all
URL Params
none
Data Params
A request of the service to delete all config options sections from.
{
"serviceName": "mqtt-serivce",
"deleteRunningConfig": true
}
Success Response
200 - A response of the result of the deletion.
{
"result": true,
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
ConfigToken
API Calls
online
Check if the Config Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/online
**URL Params**
```json
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
get
Get a list of config variable tokens.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/get
URL Params
none
Data Params
A request with the list of config variable tokens to retrieve.
{
"tokens": [
"IoTnxtAddress"
]
}
Success Response
200 - A response with the list of config variable tokens retrieved.
{
"tokens": [
{
"token": "IoTnxtAddress",
"description": "The IoT.nxt Head office Address",
"value": "Bylsbridge Office Park, Building 14 (Block C, 1st FL, Alexandra Rd, Doringkloof, Centurion, 0169",
"readOnly": true,
"lastUpdateUtc": "2021-03-17T10:08:43.3431762Z"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
add
Add a list of config variable tokens.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/add
URL Params
none
Data Params
A request with the list of config variable tokens to add.
{
"tokens": [
{
"token": "IoTnxtAddress",
"description": "The IoT.nxt Head office Address",
"value": "Bylsbridge Office Park, Building 14 (Block C, 1st FL, Alexandra Rd, Doringkloof, Centurion, 0169",
"readOnly": true,
"lastUpdateUtc": "2021-03-17T10:08:43.3532559Z"
}
]
}
**Success Response**
200 - A response with the list of config variable tokens that were added.
```json
{
"results": {
"IoTnxtAddress": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
update
Update a list of config variable tokens.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/update
URL Params
none
Data Params
A request with the list of config variable tokens to update.
{
"tokens": [
{
"token": "IoTnxtAddress",
"description": "The IoT.nxt Head office Address",
"value": "Bylsbridge Office Park, Building 14 (Block C, 1st FL, Alexandra Rd, Doringkloof, Centurion, 0169",
"readOnly": true,
"lastUpdateUtc": "2021-03-17T10:08:43.3614486Z"
}
]
}
**Success Response**
200 - A response with the list of config variable tokens that were updated.
```json
{
"results": {
"IoTnxtAddress": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
delete
Delete a list of config variable tokens.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/delete
URL Params
none
Data Params
A request with the list of config variable tokens to delete.
{
"tokens": [
"IoTnxtAddress"
]
}
Success Response
200 - A response with the list of config variable tokens that were deleted.
{
"results": {
"IoTnxtAddress": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
exists
Check a list of config variable tokens if they are existing.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/config/token/exists
URL Params
none
Data Params
A request with a list of config variable tokens to check if they are existing.
{
"tokens": [
"IoTnxtRegisteredName"
]
}
**Success Response**
200 - A response with a key-value pair of the tokens and their existing checks.
```json
{
"results": {
"IoTnxtRegisteredName": true
},
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Health
API Calls
online
Check if the Health Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/health/online
**URL Params**
```json
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
health
Get the health for a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/health
URL Params
none
Data Params
A request with the list of raptor services to retrieve health for.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
Success Response
200 - A list raptor services with their health.
{
"results": [
{
"serviceName": "mqtt-service",
"health": "Healthy"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
rag
Get the rag status for a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/health/rag
URL Params
none
Data Params
A request with the list of raptor services to retrieve rag status for.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
**Success Response**
200 - A list raptor services with their rag status.
```json
{
"results": [
{
"serviceName": "mqtt-service",
"rag": "Green"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
metrics
Get the metrics for a list of raptor services.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/health/metrics
URL Params
none
Data Params
A request with the list of raptor services to retrieve metrics for.
{
"serviceTypeFilter": [
"*"
],
"serviceNameFilter": [
"*"
]
}
**Success Response**
200 - A list raptor services with their metrics status.
```json
{
"results": [
{
"serviceName": "mqtt-service",
"metrics": [
{
"name": "ConnectedClientCount",
"description": "Number of connected Clients on the active VRaptor Instance.",
"type": "gauge",
"value": "2"
}
],
"rawMetrics": "\n# HELP ConnectionManager:ConnectedClientCount Number of connected Clients on the active VRaptor Instance.\n# TYPE ConnectionManager:ConnectedClientCount gauge\nConnectionManager:ConnectedClientCount 2"
}
],
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
CentralConfig
API Calls
online
Check if the Service Management Controller is online.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/central-config/online
URL Params
none
Data Params
none
Success Response
200 - Returns the status and version of the service.
{
"version": "Service is online. Running on version [X.X.X.X].",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
get
Retrieve the raptor's central config.
Permission
No permission check
URL
https://community-vraptor.iotnxt.io/deployment/api/central-config/get
**URL Params**
```json
none
Data Params
none
Success Response
200 - A response containing the internal and public domains of the raptor.
{
"internalDomain": "vraptor01",
"publicDomain": "vraptor01.commander.io",
"isError": false,
"subResponses": []
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
Authorize
API Calls
RequestAccessToken
Get Access Token for Auth
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/Authorize/RequestAccessToken
URL Params
none
Data Params
A request with the list of raptor authorization required.
{
"serviceId": "string",
"signature": "string"
}
Success Response
200 - Success
{
"token": "string",
"tokenType": "string"
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None
LogonToCommander
Log into Commander Dashboard.
Permission
Raptor authentication required
URL
https://community-vraptor.iotnxt.io/deployment/api/Authorize/LogonToCommander
URL Params
none
Data Params
A request with login credentials for Commander Dashboard.
{
"username": "string",
"password": "string"
}
Success Response
200 - Success
{
"token": "string",
"tokenType": "string"
}
Error Response
- 400 - One of the parameters is invalid.
- 401 - Authentication is invalid.
- 403 - Not authorized to process this request.
- 500 - Service encountered an unexpected error while processing the request.
Notes
None