7 Nodes

7.1 Get Nodes

GET https://<HOST>:<PORT>/api/nodes/get?version=0

Returns all configured nodes.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 27.44.1. For the JSON schema refer to section 27.44.2.

Example

GET http://127.0.0.1:8111/api/nodes/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Speedvoice test",
    "id": "4e8313ff-3307-4856-ab3f-8be80c4c7629"
  },
  {
    "displayName": "Amazon Chime test",
    "id": "b3221b7f-ea11-45df-9bc6-a96fd5f5b7bc"
  }
]

7.2 Enable Node

POST https://<HOST>:<PORT>/api/nodes/enable?version=0

Enables a node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node that will be enabled.

Example

POST http://localhost:8888/api/nodes/enable?node=630f4238-6883-4ecd-8239-cf5d9756f3da&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Node enabled

7.3 Disable Node

POST https://<HOST>:<PORT>/api/nodes/disable?version=0

Disables a node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node that will be disabled.

Example

POST http://localhost:8888/api/nodes/disable?node=630f4238-6883-4ecd-8239-cf5d9756f3da&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Node disabled

7.4 Get System Profiles

GET https://<HOST>:<PORT>/api/nodes/systemProfiles/get?version=0

Retrieves a list of all possible system profiles that can be used to add a PBX or Voice over IP System.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • completeData

    Type: Boolean

    Indicates if additional data for each node should be included.

Response Body Structure

The response body is strutured as an array. The array consists of GetSystemsProfilesProfile JSON objects. A description for its fields is at section 27.45.1. For the JSON schema refer to section 27.45.2.

Example

GET http://127.0.0.1:8110/api/nodes/systemProfiles/get?completeData=true&version=0
HTTP Response Body
[
  {
    "activateServerAuthentication": true,
    "serverCredentials": {},
    "displayName": "[Other VoIP System]",
    "includeSipRegistrarInWhitelist": true,
    "includeRemoteSipDomainInWhitelist": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "createNewTeamsCarrierNode": true,
    "routingDomains": [],
    "includeOwnSubnetInWhitelist": true,
    "sbcFqdn": "",
    "clientCredentials": {},
    "id": "2380B08F-93F8-468C-B302-A52C91B30828",
    "activateClientAuthentication": false,
    "networkControllerInterface": "",
    "tenantFqdn": "",
    "createNewNetworkController": true,
    "remoteSipDomain": {},
    "networkPeerWhitelist": [],
    "sipRegistrar": {"type": "ALWAYS"},
    "networkControllerDisplayName": "[Other VoIP System]",
    "udpPortRange": {
      "lastPort": 13000,
      "firstPort": 10000
    },
    "useNetworkPeerWhitelist": true,
    "sipInterconnection": "TRUNK",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]"
  },
  {
    "activateServerAuthentication": true,
    "serverCredentials": {},
    "displayName": "3CX Phone System",
    "includeSipRegistrarInWhitelist": true,
    "includeRemoteSipDomainInWhitelist": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "createNewTeamsCarrierNode": true,
    "routingDomains": [],
    "includeOwnSubnetInWhitelist": true,
    "sbcFqdn": "",
    "clientCredentials": {},
    "id": "A7D45C2D-EB6D-4F4C-9F4F-C0B9C4CD3A19",
    "activateClientAuthentication": false,
    "networkControllerInterface": "",
    "tenantFqdn": "",
    "createNewNetworkController": true,
    "remoteSipDomain": {},
    "networkPeerWhitelist": [],
    "sipRegistrar": {"type": "ALWAYS"},
    "networkControllerDisplayName": "3CX Phone System",
    "udpPortRange": {
      "lastPort": 13000,
      "firstPort": 10000
    },
    "useNetworkPeerWhitelist": true,
    "sipInterconnection": "TRUNK",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]"
  }
]

7.5 Get Microsoft teams carrier nodes.

GET https://<HOST>:<PORT>/api/nodes/msTeamsCarriers/get?version=0

Retrieves a list of all configured Nodes using Microsoft Teams Carrier Nodes.

Required Permissions

  • API

  • Configuration Mode Read Access

Response Body Structure

The response body is strutured as an array. The array consists of GetNodesNode JSON objects. A description for its fields is at section 27.44.1. For the JSON schema refer to section 27.44.2.

Example

GET http://127.0.0.1:8111/api/nodes/msTeamsCarriers/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "displayName": "Ms Teams Direct Routing test",
  "id": "afaf59dc-d239-42d4-9378-b989bd358c6e"
}]

7.6 Add PBX or Voice over IP System

POST https://<HOST>:<PORT>/api/nodes/addSystem?version=3

Adds a new PBX or Voice over IP System node to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • profile

    The id of the profile, that should be used. To get a list of availabled profiles use section 7.4.

  • version

    3

Request Body Structure

The request body is structured as AddSystemProfile JSON object. A description for its fields is at section 27.8.1. For the JSON schema refer to section 27.8.2.

Response Body Structure

The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 27.49.1. For the JSON schema refer to section 27.49.2.

Example

POST http://127.0.0.1:8110/api/nodes/addSystem?profile=01DF27B3-6E35-46B5-BB80-CE1EB9D97870&version=3
HTTP Request Body
{
  "createNewNetworkController": true,
  "tlsPort": 5999,
  "sbcFqdn": "test.fqdn",
  "displayName": "Ms Teams Direct Routing test ",
  "udpTcpPort": 0,
  "networkControllerDisplayName": "NC 1",
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1",
  "routingDomains": ["Routing Domain"]
}
HTTP Response Body
[{
  "displayName": "Ms Teams Direct Routing test",
  "id": "d46272a8-6662-4076-ba09-6fb130e5941a"
}]

7.7 Get Provider Profiles

GET https://<HOST>:<PORT>/api/nodes/providerProfiles/get?version=0

Retrieves a list of all possible provider profiles that can be used to add a provider.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • completeData

    Type: Boolean

    Indicates if additional data for each node should be included.

Response Body Structure

The response body is strutured as an array. The array consists of GetProviderProfilesProfile JSON objects. A description for its fields is at section 27.50.1. For the JSON schema refer to section 27.50.2.

Example

GET http://127.0.0.1:8111/api/nodes/providerProfiles/get?completeData=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "networkControllerInterface": "",
    "createNewNetworkController": true,
    "createNewDeutscheTelekomSipTrunk": true,
    "activateNatTraversal": false,
    "defineAssertedUri": true,
    "deutscheTelekomNumberExtensionRange": {"zeroExtend": true},
    "credentials": {},
    "displayName": "[Other VoIP Provider]",
    "remoteSipDomain": {},
    "includeSipRegistrarInWhitelist": true,
    "networkPeerWhitelist": [],
    "includeRemoteSipDomainInWhitelist": true,
    "includeProxyInWhitelist": true,
    "nodeViaSipTrunking": false,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "networkControllerDisplayName": "[Other VoIP Provider]",
    "routingDomains": [],
    "useNetworkPeerWhitelist": true,
    "addressOfRecord": "",
    "assertedUri": "",
    "id": "9E7B52A2-B9F8-42B4-BB8A-1EFE9E376511",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]",
    "activateClientAuthentication": true
  },
  {
    "networkControllerInterface": "",
    "createNewNetworkController": true,
    "createNewDeutscheTelekomSipTrunk": true,
    "activateNatTraversal": false,
    "defineAssertedUri": false,
    "deutscheTelekomNumberExtensionRange": {"zeroExtend": true},
    "credentials": {},
    "displayName": "Amazon Chime",
    "remoteSipDomain": {},
    "includeSipRegistrarInWhitelist": true,
    "networkPeerWhitelist": [],
    "includeRemoteSipDomainInWhitelist": true,
    "includeProxyInWhitelist": true,
    "nodeViaSipTrunking": true,
    "allowOnlyNegotiatedPeersForRtpRtcp": true,
    "networkControllerDisplayName": "Amazon Chime",
    "routingDomains": [],
    "useNetworkPeerWhitelist": true,
    "addressOfRecord": "",
    "id": "42121cdc-bf69-4F6C-AE44-538b536cf434",
    "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
    "networkControllerIpAddress": "[Any Address]",
    "activateClientAuthentication": true
  }
]

7.8 Add Provider

POST https://<HOST>:<PORT>/api/nodes/addProvider?version=2

Adds a Provider Node to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • profile

    The id of the profile, that should be used. To get a list of availabled profiles use section 7.7.

  • version

    2

Request Body Structure

The request body is structured as AddProviderProfile JSON object. A description for its fields is at section 27.9.1. For the JSON schema refer to section 27.9.2.

Response Body Structure

The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 27.49.1. For the JSON schema refer to section 27.49.2.

Example

POST http://127.0.0.1:8110/api/nodes/addProvider?profile=42121cdc-bf69-4F6C-AE44-538b536cf434&version=2
HTTP Request Body
{
  "fixedTlsPort": 0,
  "createNewNetworkController": true,
  "tlsPort": 5888,
  "credentials": {
    "password": "asd",
    "username": "qwe"
  },
  "displayName": "Amazon Chime test",
  "remoteSipDomain": {
    "iri": "sip:test",
    "port": 0
  },
  "includeSipRegistrarInWhitelist": true,
  "networkPeerWhitelist": [{
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "subnetPrefixLength": 24,
    "dnsLookup": []
  }],
  "includeRemoteSipDomainInWhitelist": true,
  "includeProxyInWhitelist": true,
  "nodeViaSipTrunking": true,
  "networkControllerDisplayName": "NC 1",
  "routingDomains": [],
  "fixedUdpPortRangeStart": 0,
  "proxyUri": "sip:proxy",
  "udpTcpPort": 5887,
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1",
  "fixedUdpTcpPort": 0,
  "fixedTcpPortRangeStart": 0,
  "activateClientAuthentication": true
}
HTTP Response Body
[{
  "displayName": "Amazon Chime test",
  "id": "9a157527-6c32-4800-8f85-88c961415774"
}]

7.9 Add SIP Phones Registrar

POST https://<HOST>:<PORT>/api/nodes/addSipPhoneRegistrar?version=0

Adds a new SIP phones registrar to the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request Body Structure

The request body is structured as AddSipPhoneRegistrarProfile JSON object. A description for its fields is at section 27.10.1. For the JSON schema refer to section 27.10.2.

Response Body Structure

The response body is strutured as an array. The array consists of AddNodeResult JSON objects. A description for its fields is at section 27.49.1. For the JSON schema refer to section 27.49.2.

Example

POST http://127.0.0.1:8110/api/nodes/addSipPhoneRegistrar?version=0
HTTP Request Body
{
  "createNewNetworkController": true,
  "tlsPort": 5888,
  "displayName": "SIP Phones Registrar test",
  "networkPeerWhitelist": [{
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "subnetPrefixLength": 24,
    "dnsLookup": []
  }],
  "sipPhoneRegistrarDirectoryId": "a29117f9-1474-4ad0-8b52-2ac1b5e654cf",
  "allowOnlyNegotiatedPeersForRtpRtcp": false,
  "networkControllerDisplayName": "NC 1",
  "routingDomains": [],
  "includeOwnSubnetInWhitelist": false,
  "useNetworkPeerWhitelist": false,
  "udpTcpPort": 5887,
  "networkControllerIpVersion": "IN_ADDRESS_VERSION_4",
  "networkControllerIpAddress": "127.0.0.1"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "SIP Phones Registrar test",
    "id": "941ae82e-2f37-4c34-9981-62805c16041b"
  },
  {
    "displayName": "SIP Phones Registrar test",
    "id": "af28a0e0-02cd-4a96-b87c-0f9b005cbd27"
  }
]

7.10 Remove Node

DELETE https://<HOST>:<PORT>/api/nodes/remove?version=0

Removes a node from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node that should be removed

  • force

    Type: Boolean

    If this is true, objects will be deleted even if they have other references than this node. This can cause errors inside the configuration.

Example

DELETE http://127.0.0.1:8111/api/nodes/remove?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&force=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Node was removed.

7.11 Get Port

GET https://<HOST>:<PORT>/api/nodes/port/get?version=0

Returns the UDP/TCP port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node that should be removed

Example

GET http://127.0.0.1:8111/api/nodes/port/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2222

7.12 Set Port

PUT https://<HOST>:<PORT>/api/nodes/port/set?version=0

Modifies the UDP/TCP port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node which port should be modified.

Request Body Structure

The body must contain the new UDP/TCP port for the given node.

Example

PUT http://127.0.0.1:8110/api/nodes/port/set?node=9a157527-6c32-4800-8f85-88c961415774&version=0
HTTP Request Body
2222
HTTP Response Body
2222

7.13 Get TlsPort

GET https://<HOST>:<PORT>/api/nodes/tlsPort/get?version=0

Returns the TLS port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node that should be removed

Example

GET http://127.0.0.1:8110/api/nodes/tlsPort/get?node=9a157527-6c32-4800-8f85-88c961415774&version=0
HTTP Response Body
2223

7.14 Set TlsPort

PUT https://<HOST>:<PORT>/api/nodes/tlsPort/set?version=0

Modifies the TLS port of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node which port should be modified.

Request Body Structure

The body must contain the new TLS port for the given node.

Example

PUT http://127.0.0.1:8111/api/nodes/tlsPort/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
2223
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
2223

7.15 Get Teams FQDN

GET https://<HOST>:<PORT>/api/nodes/tenants/fqdn/get?version=0

Returns the FQDN of the requested Teams node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the Teams node which FQDN should be returned.

Example

GET http://127.0.0.1:8111/api/nodes/tenants/fqdn/get?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.fqdn

7.16 Set Teams FQDN

PUT https://<HOST>:<PORT>/api/nodes/tenants/fqdn/set?version=0

Modifies the FQDN of the requested Teams node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the Teams node which FQDN should be returned.

Request Body Structure

The body must contain the new FQDN for the Teams node.

Example

PUT http://127.0.0.1:8110/api/nodes/tenants/fqdn/set?node=d46272a8-6662-4076-ba09-6fb130e5941a&version=0
HTTP Request Body
test.fqdn
HTTP Response Body
test.fqdn

7.17 Get Hostname/FQDN

GET https://<HOST>:<PORT>/api/nodes/overrideHostname/get?version=0

Returns the hostname/FQDN of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node which hostname/FQDN should be returned.

Example

GET http://127.0.0.1:8111/api/nodes/overrideHostname/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.hostname

7.18 Set Hostname/FQDN

PUT https://<HOST>:<PORT>/api/nodes/overrideHostname/set?version=0

Modifies the hostname/FQDN of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or display name of the node which hostname/FQDN should be modified.

Request Body Structure

The body must contain the new hostname/FQDN for the requested node.

Example

PUT http://127.0.0.1:8111/api/nodes/overrideHostname/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
test.hostname
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
test.hostname

7.19 Get Network Security Profile Name

GET https://<HOST>:<PORT>/api/nodes/networkSecurityProfileName/get?version=0

Returns the id of the current network security profile for the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node which network security profile name will be returned

Example

GET http://127.0.0.1:8111/api/nodes/networkSecurityProfileName/get?node=d67c705c-3e1a-4542-a454-18f625a1d42e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
152925d9-8859-4694-99f2-ff50564ead00

7.20 Set Network Security Profile Name

PUT https://<HOST>:<PORT>/api/nodes/networkSecurityProfileName/set?version=0

Modifies the network security profile for the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node which network security profile should be modified.

Request Body Structure

The body must contain the new network security profile id.

Example

PUT http://127.0.0.1:8111/api/nodes/networkSecurityProfileName/set?node=d67c705c-3e1a-4542-a454-18f625a1d42e&version=0
HTTP Request Body
152925d9-8859-4694-99f2-ff50564ead00
HTTP Response
HTTP/1.1 200 OK

7.21 Get Certificate

GET https://<HOST>:<PORT>/api/nodes/certificates/get?version=0

Returns the certificate of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or display name of the node which certificate should be returned.

7.22 Set Certificate

PUT https://<HOST>:<PORT>/api/nodes/certificates/set?version=0

Modifies the certificate of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • mode

    Determines which items will be modified with the uploaded file.

    Type: mode

    Possible Values:

    • CERTIFICATES_AND_PRIVATE_KEY

    • CERTIFICATES_ONLY

    • PRIVATE_KEY_ONLY

  • node

    The id or displayName of the Node to be modified.

  • password

    The password of the certificate file.

  • filepath

    The path to the file that will be imported.

Request Body Structure

The body must contain the certificate file.

Example

PUT http://127.0.0.1:8111/api/nodes/certificates/set?mode=PRIVATE_KEY_ONLY&node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "keySize": 2048,
  "keyType": "RSA"
}]

7.23 Get Transport Connections

GET https://<HOST>:<PORT>/api/nodes/transportConnections/get?version=0

Returns the transport connection of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node whose transport connections should be returned.

Response Body Structure

The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Example

GET http://127.0.0.1:8111/api/nodes/transportConnections/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnectionId": "e35c28d6-e08b-4d61-bd60-1ec27d47a25f"
}]

7.24 Add Transport Connection

POST https://<HOST>:<PORT>/api/nodes/transportConnections/add?version=0

Adds a transport connection to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node where the Transport Connection will be added..

Request Body Structure

The request body is structured as SipNodeTransportConnection JSON object. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Response Body Structure

The response body is structured as SipNodeTransportConnection JSON object. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Example

POST http://127.0.0.1:8111/api/nodes/transportConnections/add?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnectionId": "fa6f5ae7-38c9-44f4-a427-107e4068305b"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnection": {
    "displayName": "test_connection",
    "id": "fa6f5ae7-38c9-44f4-a427-107e4068305b"
  }
}

7.25 Clear Transport Connections

DELETE https://<HOST>:<PORT>/api/nodes/transportConnections/clear?version=0

Removes all transport connections of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node whose transport connections should be returned.

  • removeRoutes

    Decide if the routes should be removed or not.

Example

DELETE http://127.0.0.1:8111/api/nodes/transportConnections/clear?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&removeRoutes=true&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Cleared transport connections.

7.26 Set Transport Connections

POST https://<HOST>:<PORT>/api/nodes/transportConnections/set?version=0

Replaces the Transport Connections of the requested Node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node whose Transport Connections will be modified.

Request Body Structure

The request body is strutured as JSON array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Response Body Structure

The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Example

POST http://127.0.0.1:8111/api/nodes/transportConnections/set?node=13ec4e32-dd3c-42cc-a5cd-f7f205c965e9&version=0
HTTP Request Body
[
  {
    "matchingCondition": {"type": "ALWAYS"},
    "transportConnectionId": "537ebd60-8c8c-4399-a584-0043036b5e0d"
  },
  {
    "matchingCondition": {"type": "ALWAYS"},
    "transportConnectionId": "770f120d-3539-4ed2-be0b-46e9f5626e97"
  }
]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "matchingCondition": {"type": "ALWAYS"},
    "transportConnectionId": "537ebd60-8c8c-4399-a584-0043036b5e0d"
  },
  {
    "matchingCondition": {"type": "ALWAYS"},
    "transportConnectionId": "770f120d-3539-4ed2-be0b-46e9f5626e97"
  }
]

7.27 Remove Transport Connection

DELETE https://<HOST>:<PORT>/api/nodes/transportConnections/remove?version=0

Removes a Transport Connection and it's matching condition from the requested Node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • index

    The index of the Transport Connection that will be removed.

Response Body Structure

The response body is strutured as an array. The array consists of SipNodeTransportConnection JSON objects. A description for its fields is at section 27.11.1. For the JSON schema refer to section 27.11.2.

Example

DELETE http://127.0.0.1:8111/api/nodes/transportConnections/remove?node=cefb8b4f-651f-4afe-8685-9670e791509e&index=0&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "matchingCondition": {"type": "ALWAYS"},
  "transportConnectionId": "52d4c6ab-f315-4dc6-b6ba-b56236dd39f8"
}]

7.28 Add Trusted Certificates

PUT https://<HOST>:<PORT>/api/nodes/trustedCertificates/add?version=0

Adds a new certificate to the list of trusted certificates for the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • node

    The id or displayName of the Node to be modified.

  • password

    The password of the certificate file.

Request Body Structure

The body must contain the certificate file.

7.29 Clear Trusted Certificates

DELETE https://<HOST>:<PORT>/api/nodes/trustedCertificates/clear?version=0

Removes all trusted certificates from the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.

7.30 Get Incoming Dial String Rewrite Rules

GET https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/get?version=0

Returns the incoming dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node

  • includeDefaults

    Whether default values should be displayed or not.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

GET http://127.0.0.1:8110/api/nodes/incomingDialStringRewriteRules/get?node=d46272a8-6662-4076-ba09-6fb130e5941a&version=0
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.31 Set Incoming Dial String Rewrite Rules

PUT https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/set?version=0

Modifies the incoming dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

PUT http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/set?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.32 Add Incoming Dial String Rewrite Rules

POST https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/add?version=0

Adds additional dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

POST http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/add?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.33 Remove Incoming Dial String Rewrite Rules

DELETE https://<HOST>:<PORT>/api/nodes/incomingDialStringRewriteRules/remove?version=0

Removes incoming dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • displayName

    The displayName or id of the incoming dial string rewrite rule to be removed.

  • index

    The index of the incoming dial string rewrite rule to be removed.

Example

DELETE http://127.0.0.1:8111/api/nodes/incomingDialStringRewriteRules/remove?node=afaf59dc-d239-42d4-9378-b989bd358c6e&index=0&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[]

7.34 Get Outgoing Dial String Rewrite Rules

GET https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/get?version=0

Returns the outgoing dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

GET http://127.0.0.1:8110/api/nodes/outgoingDialStringRewriteRules/get?node=d46272a8-6662-4076-ba09-6fb130e5941a&version=0
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.35 Set Outgoing Dial String Rewrite Rules

PUT https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/set?version=0

Modifies the outgoing dial string rewrite rules of the requested node

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

PUT http://127.0.0.1:8110/api/nodes/outgoingDialStringRewriteRules/set?node=d46272a8-6662-4076-ba09-6fb130e5941a&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.36 Add Outgoing Dial String Rewrite Rules

POST https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/add?version=0

Adds additional dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Response Body Structure

The response body is strutured as an array. The array consists of DialStringRewrite JSON objects. A description for its fields is at section 27.14.1. For the JSON schema refer to section 27.14.2.

Example

POST http://127.0.0.1:8110/api/nodes/outgoingDialStringRewriteRules/add?node=d46272a8-6662-4076-ba09-6fb130e5941a&version=0
HTTP Request Body
[{
  "applyToDestinationDialString": false,
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "index": 0,
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "applyToAllDialStrings": false,
  "case": "lowercase",
  "addPrefix": "2"
}]
HTTP Response Body
[{
  "prefix": "123",
  "displayName": "test",
  "addSuffix": "3",
  "matchTags": {
    "tagSet": [
      "userIp",
      "userPhone"
    ],
    "type": "xor"
  },
  "deleteTrailingCharacters": 2,
  "suffix": "456",
  "deleteLeadingCharacters": 1,
  "clearDisplayName": false,
  "rewriteType": "prefixAndSuffix",
  "skipRulesBelow": false,
  "skipFurtherRules": true,
  "comment": "Prefix Suffix Rewrite",
  "tagRewrite": {
    "operations": [
      {
        "tag": "userIp",
        "type": "keep"
      },
      {
        "tag": "userPhone",
        "type": "delete"
      }
    ],
    "clearTags": false
  },
  "applyToSourceDialString": true,
  "case": "lowercase",
  "addPrefix": "2"
}]

7.37 Remove Outgoing Dial String Rewrite Rules

DELETE https://<HOST>:<PORT>/api/nodes/outgoingDialStringRewriteRules/remove?version=0

Removes outgoing dial string rewrite rules to the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • displayName

    The displayName or id of the incoming dial string rewrite rule to be removed.

  • index

    The index of the incoming dial string rewrite rule to be removed.

Example

DELETE http://127.0.0.1:8110/api/nodes/outgoingDialStringRewriteRules/remove?node=d46272a8-6662-4076-ba09-6fb130e5941a&index=0&version=0
HTTP Response Body
[]

7.38 Get Network Peer Whitelist

GET https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/get?version=0

Returns the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node.

Response Body Structure

The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Example

GET http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/get?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  },
  {
    "ipVersion": "[Any Address Version]",
    "host": "proxy",
    "hostnameFlags": {
      "querySrvRecords": true,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": true
    },
    "dnsLookup": [
      "_sip._udp",
      "_sip._tcp",
      "_sips._tcp"
    ]
  }
]

7.39 Set Network Peer Whitelist

PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/set?version=0

Modifies the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

Request Body Structure

The request body is strutured as JSON array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Response Body Structure

The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Example

PUT http://127.0.0.1:8111/api/nodes/networkPeerWhitelist/set?node=927aabf0-14a1-44c6-b30b-2a54f95e1a76&version=0
HTTP Request Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "subnetPrefixLength": 24,
  "dnsLookup": []
}]
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "hostnameFlags": {
    "querySrvRecords": false,
    "interpretAsIpAddress": false,
    "queryAAndAaaaRecords": false
  },
  "subnetPrefixLength": 24
}]

7.40 Add Network Peer Whitelist Entry

PUT https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/add?version=0

Adds a new entry to the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node

Request Body Structure

The request body is structured as NetworkPeerWhitelistEntry JSON object. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Response Body Structure

The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Example

PUT http://127.0.0.1:8110/api/nodes/networkPeerWhitelist/add?node=9a157527-6c32-4800-8f85-88c961415774&version=0
HTTP Request Body
{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "test2.fqdn",
  "subnetPrefixLength": 24,
  "dnsLookup": []
}
HTTP Response Body
[
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "127.0.0.1",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  },
  {
    "ipVersion": "IN_ADDRESS_VERSION_4",
    "host": "test2.fqdn",
    "hostnameFlags": {
      "querySrvRecords": false,
      "interpretAsIpAddress": false,
      "queryAAndAaaaRecords": false
    },
    "subnetPrefixLength": 24
  }
]

7.41 Remove Network Peer Whitelist Entry

DELETE https://<HOST>:<PORT>/api/nodes/networkPeerWhitelist/remove?version=0

Removes a entry from the network peer whitelist of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node.

  • hostname

    Type: String

    The host of the network peer whitelist entry to be removed.

  • index

    The index of the network peer whitelist entry to be removed.

Response Body Structure

The response body is strutured as an array. The array consists of NetworkPeerWhitelistEntry JSON objects. A description for its fields is at section 27.12.1. For the JSON schema refer to section 27.12.2.

Example

DELETE http://127.0.0.1:8110/api/nodes/networkPeerWhitelist/remove?node=9a157527-6c32-4800-8f85-88c961415774&hostname=test2.fqdn&version=0
HTTP Response Body
[{
  "ipVersion": "IN_ADDRESS_VERSION_4",
  "host": "127.0.0.1",
  "hostnameFlags": {
    "querySrvRecords": false,
    "interpretAsIpAddress": false,
    "queryAAndAaaaRecords": false
  },
  "subnetPrefixLength": 24
}]

7.42 Get Certificate Chain

GET https://<HOST>:<PORT>/api/nodes/certificateChain/get?version=0

Returns the chain certificate information for the requested node.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • node

    The id or displayName of the Node whose certificate chain should be returned.

Response Body Structure

The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 27.54.1. For the JSON schema refer to section 27.54.2.

7.43 Add Chain Certificate

POST https://<HOST>:<PORT>/api/nodes/certificateChain/add?version=0

Adds Certificates to the certificate chain of the requested node.

Required Permissions

  • API

  • Administration

Request parameters

  • node

    The id or displayName of the Node to be modified.

  • certificateFilePath

    The path to the file that will be imported.

Request Body Structure

The body must contain the certificate file.

Response Body Structure

The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 27.54.1. For the JSON schema refer to section 27.54.2.

Example

POST http://127.0.0.1:8111/api/nodes/certificateChain/add?node=afaf59dc-d239-42d4-9378-b989bd358c6e&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[{
  "extendedUsage": ["AGE_FLAG_"],
  "serial": "410629b7c3f607de",
  "signingAlgorithm": "RSA_SHA256",
  "subject": "CN=test.chaincert",
  "usage": [
    "DIGITAL_SIGNATURE",
    "KEY_ENCIPHERMENT",
    "DATA_ENCIPHERMENT",
    "KEY_AGREEMENT"
  ],
  "fingerprintAlgorithm": "SHA1",
  "fingerprint": "58A8F3CCACFE2CF55ED911758D29F23F776400B7",
  "validUntil": "UTC 2024-07-04 13:22:00",
  "validFrom": "UTC 2023-07-05 13:22:00",
  "version": "V3",
  "certificateAuthority": "no",
  "issuer": "CN=test.chaincert"
}]

7.44 Remove Chain Certificate

DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/remove?version=0

Removes a certificate from the certificate chain of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Response Body Structure

The response body is strutured as an array. The array consists of CertificateListEntry JSON objects. A description for its fields is at section 27.54.1. For the JSON schema refer to section 27.54.2.

7.45 Clear Certificate Chain

DELETE https://<HOST>:<PORT>/api/nodes/certificateChain/clear?version=0

Removes all certificates from the certificate chain of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.

7.46 Request Certificate Chain

POST https://<HOST>:<PORT>/api/nodes/certificateChain/request?version=0

Requests the certificate chain for the configured certificate of the requested node.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • node

    The id or displayName of the Node to be modified.