26 Detached Objects

The structure of the objects returned by the functions in this chapter may vary depending on the anynode version.

26.1 Get Sorts

GET https://<HOST>:<PORT>/api/objects/sorts?version=0

Returns (depending on its paramters) a list of object sorts, a list of objects of a specific sort or a single object of a specific sort.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • displayName

    If this parameter is supplied additionally to the sort only the object with this display name will be returned.

  • sort

    If this parameter is not present, a list of all sorts will be returned. If a sort is selected with this parameter, all objects of that sort are returned.

    Possible values:

    • USRAGG_DIRECTORY (Aggregate Directory)

    • AN_SIPLB_STACK (Load Balancer)

    • AN_SIPRT_ROUTE (Standard Transport Connection)

    • AZURE_ACTIVE_DIRECTORY (Azure Active Directory)

    • CAPIC_STACK (CAPI Client)

    • CAPIS_STACK (XCAPI Controller)

    • CAPIS_DOMAIN (XCAPI Controller Domain)

    • CS_CONDITION (Condition)

    • CS_SCHEDULER (Rate Limiter)

    • CS_STUB (Stub)

    • USRDB_DIRECTORY (Database Connected Directory)

    • CRY_X509_STACK (Digital Identity and Trust)

    • USRRT_ROUTE_SV (Directory Route Supervision)

    • MISC_TIME_REPORTER (Time Range)

    • MEDIA_PUMP_DOMAIN (Media Transcoding Options)

    • HTTP_SERVER (HTTP Server)

    • HTTP_CLIENT (HTTP Client)

    • IN_FILTER (Network Peer Whitelist)

    • IN_MAP_STACK (Network Mapping)

    • IN_MAP_STATIC_STACK (Network Static Mapping)

    • IN_STACK (Network Controller)

    • IPC_CLIENT (IPC Client)

    • IPC_SERVER (IPC Server)

    • LDAP_CONNECTION (LDAP Client Connection)

    • USRLDAP_DIRECTORY (LDAP Directory)

    • MNS_TEAMS_DOMAIN (Media Negotiation (Microsoft Teams Extensions))

    • MNS_FORWARDER_DOMAIN (Media Negotiation Forwarder)

    • MNS_STACK (Media Negotiation)

    • REC_STACK (Media Recorder)

    • RECMUX_STACK (Media Recording Multiplexer)

    • RECFILE_STACK (Media File Recorder)

    • RECTEL_STACK (Media Telephony Recorder)

    • MS_AUDIO_PROVIDER (Audio Media Source)

    • MSFILE_PROVIDER (File Media Source)

    • MS_GRAPH_CLIENT (Microsoft Graph Client)

    • TELTEAMS_STACK (Microsoft Teams Connectivity)

    • TELTEAMS_TENANT (Microsoft Teams Tenant)

    • INS_STACK (Network Security Profile)

    • NUMVALRT_ROUTE_SV (Number Validation Route Supervision)

    • OAUTH_CLIENT (OAuth Client)

    • PROVISIONING_SERVER (Provisioning Server)

    • IN_QOS_STACK (QoS Profile)

    • RESTRT_ROUTE_SV (REST Client Route Supervision)

    • SIPAUTH_STACK (Authentication Profile)

    • SIPLB_STACK (Load Balancing Transport Connection)

    • SIPPX_STACK (Request Router)

    • RECSIPREC_STACK (SIPREC Media Recorder)

    • TELSIPREG_REGISTRAR (SIP Registrar)

    • SIPRT_PLAIN_ROUTE (Plain Transport Connection)

    • SIPST_STACK (SIP Transport)

    • SIPUA_REGISTRATION (SIP Registration)

    • SIPUA_STACK (SIP User Agent)

    • SRVLB_STACK (SRV Load Balancer)

    • USRTEL_DIRECTORY (Static Dial string Directory)

    • USRT_DIRECTORY (Static User Directory)

    • MSTEL_PROVIDER (Telephony Media Source)

    • TELELIN_DOMAIN (ELIN Binding Database)

    • TELFW_STACK (Telephony Forwarding)

    • TEL_REWRITE_DOMAIN (Dial String Rewriting)

    • TELRT_FORWARDER_DOMAIN (Routing Forward Profile)

    • TELRT_STACK (Routing Domain)

    • TEL_STACK (Node)

    • TELCAPIC_STACK (CAPI Client Node)

    • TELCAPIS_STACK (XCAPI Controller Node)

    • TELSIP_STACK (SIP Node)

    • TELUCMA_STACK (SfB UCMA Node)

    • TELWEBRTC_STACK (WebRTC Node)

    • WEBRTC_STACK (WebRTC Server)

    • WEBSOCKET_STACK (Websocket)

Example

GET http://127.0.0.1:8888/api/objects/sorts?sort=INS_STACK&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "displayName": "Speedvoice test",
    "id": "1536e899-8afe-4ea9-aa56-a5329ec28896",
    "sort": "INS_STACK"
  },
  {
    "displayName": "Amazon Chime",
    "id": "99aaa164-302d-487c-b59a-56f75c98603d",
    "sort": "INS_STACK"
  }
]

26.2 Get Object

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

Returns the configuration of a object identified by it's id.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The id of the object that should be returned

Example

GET http://127.0.0.1:8888/api/objects/get?id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "93125985-6224-4DAA-9870-1188CAA6206A",
      "preset": "477e15b6-18bd-40ae-9a87-2f357cfe3e10",
      "compatibility": "1"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Telstra EP",
  "sort": "TEL_STACK",
  "id": "fe871c8f-bac1-4ff7-bc63-fedb01f08394",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "E4F35A0D2D999E26716B249CA8A90FC3",
    "backendStackName": "f3955ba4-26fd-4191-b7ad-56db461c192e",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

26.3 Get Unreferenced Objects

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

Returns a list of unreferenced objects of a specific sort.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • sort

    The sort of objects that will be returned. For a list of all objects sorts use section 26.1

26.4 Get Object Tree

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

Returns the object tree of a object in the configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The id of the object which tree should be returned

Example

GET http://127.0.0.1:8888/api/objects/objectTree/get?id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "name": "Telstra EP",
  "sort": "TEL_STACK",
  "id": "fe871c8f-bac1-4ff7-bc63-fedb01f08394",
  "backendStack": {
    "baseSipuaStack": {
      "baseSipstStack": {
        "insStack": {
          "cryX509Stack": {
            "name": "Telstra EP (SIP Connect)",
            "sort": "CRY_X509_STACK",
            "id": "2443891f-21c2-42b1-b0b1-de7ded5944a3"
          },
          "name": "Telstra EP (SIP Connect)",
          "sort": "INS_STACK",
          "id": "f12a5be5-9c96-47f6-814c-4f11ba9dc176"
        },
        "name": "Telstra EP (SIP Connect)",
        "inStack": {
          "name": "Telstra EP (SIP Connect)",
          "id": "5c83deec-e9bc-4a68-9e84-e0bea793ce47",
          "sort": "IN_STACK"
        },
        "sort": "SIPST_STACK",
        "id": "a23a2aa8-a74f-4071-b535-9f963db470b7",
        "inFilter": {
          "stack": {
            "name": "Telstra EP (SIP Connect)",
            "id": "5c83deec-e9bc-4a68-9e84-e0bea793ce47",
            "sort": "IN_STACK"
          },
          "name": "Telstra EP (SIP Connect)",
          "sort": "IN_FILTER",
          "id": "9e6235b4-7fd4-45a4-ab8d-b7ff6bea6184"
        }
      },
      "name": "Telstra EP (SIP Connect)",
      "mediaMnsStack": {
        "name": "Telstra EP (SIP Connect)",
        "inStack": {
          "name": "Telstra EP (SIP Connect)",
          "sort": "IN_STACK",
          "id": "5c83deec-e9bc-4a68-9e84-e0bea793ce47"
        },
        "sort": "MNS_STACK",
        "id": "4e29a222-36b2-489b-a84f-eae2f83b1204"
      },
      "sort": "SIPUA_STACK",
      "id": "f3b76e6f-01ea-4f23-b413-1d59bc820770"
    },
    "name": "Telstra EP",
    "sort": "TELSIP_STACK",
    "id": "f3955ba4-26fd-4191-b7ad-56db461c192e",
    "siprtRoute": {
      "name": "Telstra EP",
      "sort": "SIPRT_ROUTE",
      "id": "4b304ee0-a894-42c3-bd10-076a8c36c13f",
      "backendRoute": {
        "route": {
          "name": "Telstra EP 2nd Trunk Group",
          "sort": "SIPRT_ROUTE",
          "id": "c1e14ce9-bdb4-4072-85c5-206298443873",
          "backendRoute": {
            "sipauthStack": {
              "name": "Telstra EP 2nd Trunk Group",
              "sort": "SIPAUTH_STACK",
              "id": "7a173849-7d1a-4530-a7d0-1b929e4edb85"
            },
            "name": "Telstra EP 2nd Trunk Group",
            "sort": "AN_SIPRT_ROUTE",
            "id": "69e5676f-a740-45f9-aafe-18f795c6ce4a",
            "telsipStack": {
              "name": "Telstra EP",
              "id": "f3955ba4-26fd-4191-b7ad-56db461c192e",
              "sort": "TELSIP_STACK"
            }
          }
        },
        "name": "Telstra EP",
        "sort": "SIPLB_STACK",
        "id": "5e50a3f1-151a-4aed-ad4b-f7aa31608372",
        "route0": {
          "name": "Telstra EP 1th Trunk Group",
          "sort": "SIPRT_ROUTE",
          "id": "f55b0584-0f47-4cc6-8188-7a1f69dcd8a2",
          "backendRoute": {
            "sipauthStack": {
              "name": "Telstra EP 1th Trunk Group",
              "sort": "SIPAUTH_STACK",
              "id": "0e44cc8b-6aca-43d0-a27b-ed9acab95ff8"
            },
            "name": "Telstra EP 1th Trunk Group",
            "sort": "AN_SIPRT_ROUTE",
            "id": "57d6e770-fdeb-425f-9bfe-60d8b940650e",
            "telsipStack": {
              "name": "Telstra EP",
              "id": "f3955ba4-26fd-4191-b7ad-56db461c192e",
              "sort": "TELSIP_STACK"
            }
          }
        }
      }
    }
  }
}

26.5 Get Subtree Objects

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

Returns all child objects of a specific sort.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • id

    The id of the object which child objects should be returned

  • sort

    The sort of the child objects.

    Possible values:

    • USRAGG_DIRECTORY (Aggregate Directory)

    • AN_SIPLB_STACK (Load Balancer)

    • AN_SIPRT_ROUTE (Standard Transport Connection)

    • AZURE_ACTIVE_DIRECTORY (Azure Active Directory)

    • CAPIC_STACK (CAPI Client)

    • CAPIS_STACK (XCAPI Controller)

    • CAPIS_DOMAIN (XCAPI Controller Domain)

    • CS_CONDITION (Condition)

    • CS_SCHEDULER (Rate Limiter)

    • CS_STUB (Stub)

    • USRDB_DIRECTORY (Database Connected Directory)

    • CRY_X509_STACK (Digital Identity and Trust)

    • USRRT_ROUTE_SV (Directory Route Supervision)

    • MISC_TIME_REPORTER (Time Range)

    • MEDIA_PUMP_DOMAIN (Media Transcoding Options)

    • HTTP_SERVER (HTTP Server)

    • HTTP_CLIENT (HTTP Client)

    • IN_FILTER (Network Peer Whitelist)

    • IN_MAP_STACK (Network Mapping)

    • IN_MAP_STATIC_STACK (Network Static Mapping)

    • IN_STACK (Network Controller)

    • IPC_CLIENT (IPC Client)

    • IPC_SERVER (IPC Server)

    • LDAP_CONNECTION (LDAP Client Connection)

    • USRLDAP_DIRECTORY (LDAP Directory)

    • MNS_TEAMS_DOMAIN (Media Negotiation (Microsoft Teams Extensions))

    • MNS_FORWARDER_DOMAIN (Media Negotiation Forwarder)

    • MNS_STACK (Media Negotiation)

    • REC_STACK (Media Recorder)

    • RECMUX_STACK (Media Recording Multiplexer)

    • RECFILE_STACK (Media File Recorder)

    • RECTEL_STACK (Media Telephony Recorder)

    • MS_AUDIO_PROVIDER (Audio Media Source)

    • MSFILE_PROVIDER (File Media Source)

    • MS_GRAPH_CLIENT (Microsoft Graph Client)

    • TELTEAMS_STACK (Microsoft Teams Connectivity)

    • TELTEAMS_TENANT (Microsoft Teams Tenant)

    • INS_STACK (Network Security Profile)

    • NUMVALRT_ROUTE_SV (Number Validation Route Supervision)

    • OAUTH_CLIENT (OAuth Client)

    • PROVISIONING_SERVER (Provisioning Server)

    • IN_QOS_STACK (QoS Profile)

    • RESTRT_ROUTE_SV (REST Client Route Supervision)

    • SIPAUTH_STACK (Authentication Profile)

    • SIPLB_STACK (Load Balancing Transport Connection)

    • SIPPX_STACK (Request Router)

    • RECSIPREC_STACK (SIPREC Media Recorder)

    • TELSIPREG_REGISTRAR (SIP Registrar)

    • SIPRT_PLAIN_ROUTE (Plain Transport Connection)

    • SIPST_STACK (SIP Transport)

    • SIPUA_REGISTRATION (SIP Registration)

    • SIPUA_STACK (SIP User Agent)

    • SRVLB_STACK (SRV Load Balancer)

    • USRTEL_DIRECTORY (Static Dial string Directory)

    • USRT_DIRECTORY (Static User Directory)

    • MSTEL_PROVIDER (Telephony Media Source)

    • TELELIN_DOMAIN (ELIN Binding Database)

    • TELFW_STACK (Telephony Forwarding)

    • TEL_REWRITE_DOMAIN (Dial String Rewriting)

    • TELRT_FORWARDER_DOMAIN (Routing Forward Profile)

    • TELRT_STACK (Routing Domain)

    • TEL_STACK (Node)

    • TELCAPIC_STACK (CAPI Client Node)

    • TELCAPIS_STACK (XCAPI Controller Node)

    • TELSIP_STACK (SIP Node)

    • TELUCMA_STACK (SfB UCMA Node)

    • TELWEBRTC_STACK (WebRTC Node)

    • WEBRTC_STACK (WebRTC Server)

    • WEBSOCKET_STACK (Websocket)

Example

GET http://127.0.0.1:8888/api/objects/subTreeObjects/get?id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&sort=IN_STACK&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
[
  {
    "name": "Telstra EP (SIP Connect)",
    "id": "5c83deec-e9bc-4a68-9e84-e0bea793ce47",
    "sort": "IN_STACK"
  },
  {
    "name": "Telstra EP (SIP Connect)",
    "id": "5c83deec-e9bc-4a68-9e84-e0bea793ce47",
    "sort": "IN_STACK"
  }
]

26.6 Set Object

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

Modifies the options of a single object identified by it's id.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The id of the object that should be set.

Request Body Structure

The object to be set must be encoded in the requests body. All parameters in the JSON body must be given as a string. Note that only one object can be set at a time. This does not work recursively.

Example

PUT http://127.0.0.1:8888/api/objects/set?id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&version=0
HTTP Request Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "93125985-6224-4DAA-9870-1188CAA6206A",
      "preset": "477e15b6-18bd-40ae-9a87-2f357cfe3e10",
      "compatibility": "1"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Telstra EP",
  "sort": "TEL_STACK",
  "id": "fe871c8f-bac1-4ff7-bc63-fedb01f08394",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "E4F35A0D2D999E26716B249CA8A90FC3",
    "backendStackName": "f3955ba4-26fd-4191-b7ad-56db461c192e",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "93125985-6224-4DAA-9870-1188CAA6206A",
      "preset": "477e15b6-18bd-40ae-9a87-2f357cfe3e10",
      "compatibility": "1"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Telstra EP",
  "sort": "TEL_STACK",
  "id": "fe871c8f-bac1-4ff7-bc63-fedb01f08394",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "E4F35A0D2D999E26716B249CA8A90FC3",
    "backendStackName": "f3955ba4-26fd-4191-b7ad-56db461c192e",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

26.7 Remove Object

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

Deletes a object from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • id

    The id of the object that should be deleted.

Example

DELETE http://127.0.0.1:8888/api/objects/remove?id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "metaData": {"anynodefe": {
    "replication": {"systemIdentifiersEnabled": "false"},
    "note": "",
    "nodeWizard": {
      "id": "93125985-6224-4DAA-9870-1188CAA6206A",
      "preset": "477e15b6-18bd-40ae-9a87-2f357cfe3e10",
      "compatibility": "1"
    },
    "compatibility": "0",
    "version": "0"
  }},
  "visible": "true",
  "protected": "false",
  "trMark": "false",
  "comment": "Telstra EP",
  "sort": "TEL_STACK",
  "id": "fe871c8f-bac1-4ff7-bc63-fedb01f08394",
  "config": {
    "sessionsCounterLimits": {},
    "identifier": "E4F35A0D2D999E26716B249CA8A90FC3",
    "backendStackName": "f3955ba4-26fd-4191-b7ad-56db461c192e",
    "sessionsOutgoingCounterLimits": {},
    "sessionsIncomingCounterLimits": {},
    "sessionsRateLimits": {}
  }
}

26.8 Remove Objects

DELETE https://<HOST>:<PORT>/api/objects/bulkRemove?version=0

Deletes a list of objects from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Example

DELETE http://localhost:8088/api/objects/bulkRemove?version=0
HTTP Request Body
[
  "f33330ec-61f8-4d90-a61b-1f2673367658",
  "b7ccf78f-2c09-4c64-abc6-102f0dbdb972"
]
HTTP Response
HTTP/1.1 200 OK

26.9 Import Object

PUT https://<HOST>:<PORT>/api/objects/import?version=0

Imports a previously exported object into anynode.

Required Permissions

  • API

  • Configuration Mode Read/Write Access

Request parameters

  • cloneComment

    In case objects are cloned, their name will change to the given comment specified here.

  • reassignPortOnCollision

    Type: Boolean

    If set to true and the imported objects contain a SIP transport object, which ports collide with an existing SIP transport object, the ports will be reassigned automatically.

  • action

    Determines how import objects that already exist in the current config are handled.

    Possible values:

    • SKIP

      Skip duplicates and only import objects which don't exist in this configuration.

    • OVERRIDE

      Overwrite all duplicate objects. Existing objects with the same name as an imported object will be overwritten (Data may be lost).

    • CLONE

      Clone all duplicate objects. This means all current objects will be kept.

    • CANCEL

      Cancel the import request.

Request Body Structure

The request must contain a file containing the object that should be imported as "multipart/form-data".

Example

PUT http://127.0.0.1:8888/api/objects/import?action=OVERRIDE&version=0
HTTP Request Headers
Content-type : "multipart/form-data"
Accept : "application/json"
HTTP Request Body
--e2b870ea-22e6-484c-8071-94810969a4f5
Content-Disposition: form-data; name="file"; filename="object_export.json"
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
...
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
Success.

26.10 Export Object

GET https://<HOST>:<PORT>/api/objects/export?version=0

Exports a object from the current configuration.

Required Permissions

  • API

  • Configuration Mode Read Access

Request parameters

  • includePrivateData

    Determines if passwords, private keys and certificates should be included in the exported objects.

  • filename

    In case the config file should have a specific name, it can be set with this parameter. If this is not set, it will be generated automatically.

  • id

    The id of the object that should be exported.

Example

GET http://127.0.0.1:8888/api/objects/export?includePrivateData=true&id=fe871c8f-bac1-4ff7-bc63-fedb01f08394&version=0
HTTP Response
HTTP/1.1 200 OK