Release 2.2A API

This is the official api documentation for the d-serie products.

Version: 1.23.13

• get / AboutPhoneGet: Get the aboutPhone settings.
• put / AboutPhonePut: Update the aboutPhone settings.

• get / AppsGet: Get the apps-settings.
• put / AppsPut: Update the apps-settings.

• get / RemoteAccessAuthTokensGet: Get the list of auth tokens
• get / RemoteAccessAuthTokensIdxGet: Get the specified auth token at the index.
• put / RemoteAccessAuthTokensIdxPut: Update the auth token at the specified index.

• get / TelephonyCallBindingsGet: Get the CallBindings settings.
• delete / TelephonyCallBindingsNameDelete: Delete a call-binding by name
• get / TelephonyCallBindingsNameGet: Get the binding with the specified name.
• post / TelephonyCallBindingsNamePost: Create a CallBinding setup
• put / TelephonyCallBindingsNamePut: Update the binding with the specified name.
• get / TelephonyCallBindingsNameSoftkeyIdxGet: Get the key with the specified name.

• get / ContactListGet: Only a dummy get for unit tests - do not use!

• delete / ContactsDelete: Delete a contacts setup
• get / ContactsGet: Get a contacts setup
• post / ContactsPost: Create a contacts setup
• put / ContactsPut: Update a contacts settings

• get / DevicesGet: Get the Devices settings.
• post / DevicesPost: Create a Devices setup
• put / DevicesPut: Update a Devices setup.

• get / UserInterfaceDisplayGet: Get the display settings.
• put / UserInterfaceLedsPut: Update the led settings.

• get / RemoteAccessFilterSettingsGet: Get the 'filter settings' settings.
• put / RemoteAccessFilterSettingsPut: Update the 'filter settings' settings.

• get / HomeScreenDesignGet: Get the home screen design
• put / HomeScreenDesignPut: Update the home screen design

• get / IdentitiesGet: Get the list of identities
• get / IdentitiesIdxGet: Get the specified identity at the index.
• put / IdentitiesIdxPut: Update the identity at the specified index.

• delete / TelephonyCallBindingsNameSoftkeyIdxDelete: Delete a call-key by name
• post / TelephonyCallBindingsNameSoftkeyIdxPost: Create a inCallKey setup
• put / TelephonyCallBindingsNameSoftkeyIdxPut: Update the key.

• get / DevicesCamerasGet: Get the Cameras settings.
• delete / DevicesCamerasNameDelete: Delete a camera by name
• get / DevicesCamerasNameGet: Get the camera with the specified name.
• post / DevicesCamerasNamePost: Create a Camera setup
• put / DevicesCamerasNamePut: Update the camera with the specified name.

• get / KeyLayerGet: Get the keylayer settings
• put / KeyLayerPut: Set the keylayer settings

• get / UserInterfaceKeypadGet: Get the keypad settings.
• put / UserInterfaceKeypadPut: Update the keypad settings.

• get / KeysGet: Get all configured keys
• get / KeysGroupGet: Get all keys for the specified group.
• delete / KeysGroupKeyNumberDelete: Delete the key on the specified position in the group
• get / KeysGroupKeyNumberGet: Get the key on the specified position
• post / KeysGroupKeyNumberPost: Create a new key on the specified position
• put / KeysGroupKeyNumberPut: Update the key on the specified position in the group

• get / UserInterfaceLedsGet: Get the led-settings.

• get / LocalesGet: Get the locale settings.
• put / LocalesPut: Update the locale settings.

• get / LoggingGet: Get the logging settings.
• put / LoggingPut: Set the logging settings.

• get / LuaAutoStartersGet: Get the luaAutoStarters settings.
• get / LuaAutoStartersNameGet: Get the luaScript with the specified name.
• put / LuaAutoStartersNamePut: Update the luaScript with the specified name.

• get / LuaConfigGet: Get the luaConfig settings.

• get / LuaConfigKeyGet: Get the luaScript with the specified name.
• put / LuaConfigKeyPut: Update the luaScript with the specified name.

• get / LuaLibrariesGet: Get the luaLibraries settings.
• get / LuaLibrariesNameGet: Get the luaLibrary with the specified name.
• put / LuaLibrariesNamePut: Update the luaLibrary with the specified name.

• get / UserInterfaceMessagesGet: Get the messages settings.

• get / NetworkEthernetGet: Get the ethernet settings.
• put / NetworkEthernetPut: Update the ethernet settings.
• get / NetworkGet: Get the network settings.
• put / NetworkPut: Update the network settings.
• get / NetworkTopologyGet: Get the topology settings.
• post / NetworkTopologyPost: Create a Topology setup
• put / NetworkTopologyPut: Update the topology settings.
• get / NetworkVpnGet: Get the vpn settings.
• put / NetworkVpnPut: Update the vpn settings.

• get / PrivacyGet: Fetch the telephones privacy settings
• put / PrivacyPut: Update privacy settings

• get / ProvisioningGet: Get the provisionings settings.
• put / ProvisioningPut: Update the provisioning settings.

• get / RemoteAccessGet: Get the remote-access settings.
• put / RemoteAccessPut: Update the remote-access settings.

• get / ResourcesGet: Fetch the additionally provisioned resources

• get / SoundGet: Get the sound settings.
• put / SoundPut: Update the sound settings.

• get / TelephonyGet: Get the telephony settings.
• put / TelephonyPut: Update the telephony settings.

• get / TemplatesGet: Get all templates
• get / TemplatesNameGet: Get the template with the specified name.
• put / TemplatesNamePut: Update the template with the specified name.

• get / TimeAndDateGet: Get the timeAndDate settings.
• put / TimeAndDatePut: Update the timeAndDate settings

• get / UpdateGet: Get the update settings.
• put / UpdatePut: Update the update settings.

• get / UserInterfaceGet: Get settings for the user-interface.
• put / UserInterfacePut: Update settings for the user-interface.

• get / UsersGet: Get a list of users
• delete / UsersNameDelete: Delete a user. The last user can not be deleted.
• get / UsersNameGet: Returns a single user
• post / UsersNamePost: Create a single user
• put / UsersNamePut: Update a single user
• get / UsersPrimaryGet: Returns a single user
• put / UsersPrimaryPut: Update a single user
• post / UsersUseraddPost: Create a single user

• get / NetworkVpnGet: Get the vpn settings.

get /aboutPhone

Get the aboutPhone settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /aboutPhone

Update the aboutPhone settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /aboutPhone

Get the aboutPhone settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /aboutPhone

Update the aboutPhone settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /apps

Get the apps-settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /apps

Update the apps-settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /contactList

Only a dummy get for unit tests - do not use!

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contactList"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contactList"
      }
    }
  }
}

delete /contacts

Delete a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /contacts

Get a contacts setup

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

post /contacts

Create a contacts setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /contacts

Update a contacts settings

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /devices/cameras

Get the Cameras settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

delete /devices/cameras/{name}

Delete a camera by name

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /devices/cameras/{name}

Get the camera with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

post /devices/cameras/{name}

Create a Camera setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /devices/cameras/{name}

Update the camera with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /devices

Get the Devices settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

post /devices

Create a Devices setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /devices

Update a Devices setup.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /homeScreenDesign

Get the home screen design

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/homeScreenDesign"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/homeScreenDesign"
      }
    }
  }
}

put /homeScreenDesign

Update the home screen design

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /identities

Get the list of identities

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identities"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identities"
      }
    }
  }
}

get /identities/{idx}

Get the specified identity at the index.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /identities/{idx}

Update the identity at the specified index.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /keyLayer

Get the keylayer settings

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /keyLayer

Set the keylayer settings

Response Schema

{
  "description" : "Operation successful"
}

get /keys

Get all configured keys

Response Schema

{
  "description" : "A list of all groups and their configured keys",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keys"
      }
    }
  }
}

get /keys/{group}

Get all keys for the specified group.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

delete /keys/{group}/{keyNumber}

Delete the key on the specified position in the group

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /keys/{group}/{keyNumber}

Get the key on the specified position

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

post /keys/{group}/{keyNumber}

Create a new key on the specified position

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /keys/{group}/{keyNumber}

Update the key on the specified position in the group

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /locales

Get the locale settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /locales

Update the locale settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /logging

Get the logging settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /logging

Set the logging settings.

Response Schema

{
  "description" : "Operation successful"
}

get /luaAutoStarters

Get the luaAutoStarters settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /luaAutoStarters/{name}

Get the luaScript with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /luaAutoStarters/{name}

Update the luaScript with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /luaConfig

Get the luaConfig settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /luaConfig/{key}

Get the luaScript with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /luaConfig/{key}

Update the luaScript with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /luaLibraries

Get the luaLibraries settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /luaLibraries/{name}

Get the luaLibrary with the specified name.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

put /luaLibraries/{name}

Update the luaLibrary with the specified name.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

get /network/ethernet

Get the ethernet settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /network/ethernet

Update the ethernet settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /network

Get the network settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /network

Update the network settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /network/topology

Get the topology settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

post /network/topology

Create a Topology setup

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /network/topology

Update the topology settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /network/vpn

Get the vpn settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /network/vpn

Update the vpn settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /privacy

Fetch the telephones privacy settings

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/privacy"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/privacy"
      }
    }
  }
}

put /privacy

Update privacy settings

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Not Found"
}

get /provisioning

Get the provisionings settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /provisioning

Update the provisioning settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /remoteAccess/authTokens

Get the list of auth tokens

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/authTokens"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/authTokens"
      }
    }
  }
}

get /remoteAccess/authTokens/{idx}

Get the specified auth token at the index.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /remoteAccess/authTokens/{idx}

Update the auth token at the specified index.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /remoteAccess/filterSettings

Get the 'filter settings' settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /remoteAccess/filterSettings

Update the 'filter settings' settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /remoteAccess

Get the remote-access settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /remoteAccess

Update the remote-access settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /resources

Fetch the additionally provisioned resources

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/resources"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/resources"
      }
    }
  }
}

get /sound

Get the sound settings.

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    }
  }
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

put /sound

Update the sound settings.

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}

get /telephony/callBindings

Get the CallBindings settings.

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    }
  }
}