en:products:comfortel-d-series:firmware:release2.2a_api

Release 2.2A API

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

Version: 1.23.13

Endpoint overview

AboutPhoneApi

AppsApi

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

AuthTokensApi

CallBindingsApi

ContactListApi

ContactsApi

DevicesApi

DisplayApi

FilterSettingsApi

HomeScreenDesignApi

IdentitiesApi

InCallKeysApi

IpCamerasApi

KeyLayerApi

KeypadApi

KeysApi

LedsApi

LocalesApi

LoggingApi

LuaAutoStartersApi

LuaConfigApi

LuaConfigPairApi

LuaLibrariesApi

MessagesApi

NetworkApi

PrivacyApi

ProvisioningApi

RemoteAccessApi

ResourcesApi

  • get / ResourcesGet: Fetch the additionally provisioned resources

SoundApi

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

TelephonyApi

TemplatesApi

TimeAndDateApi

UpdateApi

UserInterfaceApi

UsersApi

VPNApi

Endpoint List

AboutPhoneGet

get /aboutPhone

Description

Get the aboutPhone settings.


Responses

Status Code Message Response Schema
200 Operation successfull aboutPhone

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AboutPhonePut

put /aboutPhone

Description

Update the aboutPhone settings.

Body Parameter

Name Description Required Default Pattern
aboutPhoneyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AboutPhoneGet

get /aboutPhone

Description

Get the aboutPhone settings.


Responses

Status Code Message Response Schema
200 Operation successfull aboutPhone

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AboutPhonePut

put /aboutPhone

Description

Update the aboutPhone settings.

Body Parameter

Name Description Required Default Pattern
aboutPhoneyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AppsGet

get /apps

Description

Get the apps-settings.


Responses

Status Code Message Response Schema
200 Operation successful apps

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AppsPut

put /apps

Description

Update the apps-settings.

Body Parameter

Name Description Required Default Pattern
appsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactListGet

get /contactList

Description

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


Responses

Status Code Message Response Schema
200 Operation successful array[contact]

Response Schema

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

ContactsDelete

delete /contacts

Description

Delete a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

ContactsGet

get /contacts

Description

Get a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful contacts

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPost

post /contacts

Description

Create a contacts setup

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPut

put /contacts

Description

Update a contacts settings

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for a ldap setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasGet

get /devices/cameras

Description

Get the Cameras settings.


Responses

Status Code Message Response Schema
200 Operation successful array[ipCamera]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNameDelete

delete /devices/cameras/{name}

Description

Delete a camera by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNameGet

get /devices/cameras/{name}

Description

Get the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful ipCamera

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNamePost

post /devices/cameras/{name}

Description

Create a Camera setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCameraThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNamePut

put /devices/cameras/{name}

Description

Update the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCamerayes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesGet

get /devices

Description

Get the Devices settings.


Responses

Status Code Message Response Schema
200 Operation successful devices

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesPost

post /devices

Description

Create a Devices setup

Body Parameter

Name Description Required Default Pattern
devicesThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesPut

put /devices

Description

Update a Devices setup.

Body Parameter

Name Description Required Default Pattern
devicesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

HomeScreenDesignGet

get /homeScreenDesign

Description

Get the home screen design


Responses

Status Code Message Response Schema
200 Operation successful homeScreenDesign

Response Schema

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

HomeScreenDesignPut

put /homeScreenDesign

Description

Update the home screen design

Body Parameter

Name Description Required Default Pattern
homeScreenDesignyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

IdentitiesGet

get /identities

Description

Get the list of identities


Responses

Status Code Message Response Schema
200 Operation successful array[identity]

Response Schema

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

IdentitiesIdxGet

get /identities/{idx}

Description

Get the specified identity at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the identity.yesnull


Responses

Status Code Message Response Schema
200 Operation successful identity

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

IdentitiesIdxPut

put /identities/{idx}

Description

Update the identity at the specified index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the identity.yesnull

Body Parameter

Name Description Required Default Pattern
identityyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeyLayerGet

get /keyLayer

Description

Get the keylayer settings


Responses

Status Code Message Response Schema
200 Operation successful keyLayer

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeyLayerPut

put /keyLayer

Description

Set the keylayer settings

Body Parameter

Name Description Required Default Pattern
keyLayerThe keyLayer valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

KeysGet

get /keys

Description

Get all configured keys


Responses

Status Code Message Response Schema
200 A list of all groups and their configured keys 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"
      }
    }
  }
}

KeysGroupGet

get /keys/{group}

Description

Get all keys for the specified group.

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull


Responses

Status Code Message Response Schema
200 Operation successful array[key]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberDelete

delete /keys/{group}/{keyNumber}

Description

Delete the key on the specified position in the group

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberGet

get /keys/{group}/{keyNumber}

Description

Get the key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful key

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPost

post /keys/{group}/{keyNumber}

Description

Create a new key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull

Body Parameter

Name Description Required Default Pattern
keyThe config values for the keyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPut

put /keys/{group}/{keyNumber}

Description

Update the key on the specified position in the group

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull

Body Parameter

Name Description Required Default Pattern
keyThe updated configuration for the keyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LocalesGet

get /locales

Description

Get the locale settings.


Responses

Status Code Message Response Schema
200 Operation successful locales

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LocalesPut

put /locales

Description

Update the locale settings.

Body Parameter

Name Description Required Default Pattern
localesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LoggingGet

get /logging

Description

Get the logging settings.


Responses

Status Code Message Response Schema
200 Operation successful logging

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LoggingPut

put /logging

Description

Set the logging settings.

Body Parameter

Name Description Required Default Pattern
loggingyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

LuaAutoStartersGet

get /luaAutoStarters

Description

Get the luaAutoStarters settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaAutoStartersNameGet

get /luaAutoStarters/{name}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaScriptyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaAutoStartersNamePut

put /luaAutoStarters/{name}

Description

Update the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaScriptyesnull

Body Parameter

Name Description Required Default Pattern
luaScriptyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaConfigGet

get /luaConfig

Description

Get the luaConfig settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaConfigPair]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaConfigKeyGet

get /luaConfig/{key}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
keyThe name of the variableyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaConfigPair

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaConfigKeyPut

put /luaConfig/{key}

Description

Update the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
keyThe name of the variableyesnull

Body Parameter

Name Description Required Default Pattern
luaConfigPairyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaLibrariesGet

get /luaLibraries

Description

Get the luaLibraries settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaLibrariesNameGet

get /luaLibraries/{name}

Description

Get the luaLibrary with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaLibraryyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaLibrariesNamePut

put /luaLibraries/{name}

Description

Update the luaLibrary with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaLibraryyesnull

Body Parameter

Name Description Required Default Pattern
luaScriptyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

NetworkEthernetGet

get /network/ethernet

Description

Get the ethernet settings.


Responses

Status Code Message Response Schema
200 Operation successful ethernet

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkEthernetPut

put /network/ethernet

Description

Update the ethernet settings.

Body Parameter

Name Description Required Default Pattern
ethernetyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkGet

get /network

Description

Get the network settings.


Responses

Status Code Message Response Schema
200 Operation successful network

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkPut

put /network

Description

Update the network settings.

Body Parameter

Name Description Required Default Pattern
networkyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyGet

get /network/topology

Description

Get the topology settings.


Responses

Status Code Message Response Schema
200 Operation successful topology

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyPost

post /network/topology

Description

Create a Topology setup

Body Parameter

Name Description Required Default Pattern
topologyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyPut

put /network/topology

Description

Update the topology settings.

Body Parameter

Name Description Required Default Pattern
topologyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkVpnGet

get /network/vpn

Description

Get the vpn settings.


Responses

Status Code Message Response Schema
200 Operation successful vpn

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkVpnPut

put /network/vpn

Description

Update the vpn settings.

Body Parameter

Name Description Required Default Pattern
vpnyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

PrivacyGet

get /privacy

Description

Fetch the telephones privacy settings


Responses

Status Code Message Response Schema
200 Operation successful privacy

Response Schema

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

PrivacyPut

put /privacy

Description

Update privacy settings

Body Parameter

Name Description Required Default Pattern
privacyThe privacy settingsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

ProvisioningGet

get /provisioning

Description

Get the provisionings settings.


Responses

Status Code Message Response Schema
200 Operation successful provisioning

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ProvisioningPut

put /provisioning

Description

Update the provisioning settings.

Body Parameter

Name Description Required Default Pattern
provisioningyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessAuthTokensGet

get /remoteAccess/authTokens

Description

Get the list of auth tokens


Responses

Status Code Message Response Schema
200 Operation successful array[authToken]

Response Schema

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

RemoteAccessAuthTokensIdxGet

get /remoteAccess/authTokens/{idx}

Description

Get the specified auth token at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the auth token.yesnull


Responses

Status Code Message Response Schema
200 Operation successful authToken

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessAuthTokensIdxPut

put /remoteAccess/authTokens/{idx}

Description

Update the auth token at the specified index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the auth token.yesnull

Body Parameter

Name Description Required Default Pattern
authTokenyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessFilterSettingsGet

get /remoteAccess/filterSettings

Description

Get the 'filter settings' settings.


Responses

Status Code Message Response Schema
200 Operation successfull filterSettings

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessFilterSettingsPut

put /remoteAccess/filterSettings

Description

Update the 'filter settings' settings.

Body Parameter

Name Description Required Default Pattern
filterSettingsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessGet

get /remoteAccess

Description

Get the remote-access settings.


Responses

Status Code Message Response Schema
200 Operation successful remoteAccess

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessPut

put /remoteAccess

Description

Update the remote-access settings.

Body Parameter

Name Description Required Default Pattern
remoteAccessyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ResourcesGet

get /resources

Description

Fetch the additionally provisioned resources


Responses

Status Code Message Response Schema
200 Operation successful resources

Response Schema

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

SoundGet

get /sound

Description

Get the sound settings.


Responses

Status Code Message Response Schema
200 Operation successfull sound

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

SoundPut

put /sound

Description

Update the sound settings.

Body Parameter

Name Description Required Default Pattern
soundyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsGet

get /telephony/callBindings

Description

Get the CallBindings settings.


Responses

Status Code Message Response Schema
200 Operation successful array[callBinding]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameDelete

delete /telephony/callBindings/{name}

Description

Delete a call-binding by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameGet

get /telephony/callBindings/{name}

Description

Get the binding with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful callBinding

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNamePost

post /telephony/callBindings/{name}

Description

Create a CallBinding setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull

Body Parameter

Name Description Required Default Pattern
callBindingThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNamePut

put /telephony/callBindings/{name}

Description

Update the binding with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull

Body Parameter

Name Description Required Default Pattern
callBindingyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxDelete

delete /telephony/callBindings/{name}/softkey/{idx}

Description

Delete a call-key by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxGet

get /telephony/callBindings/{name}/softkey/{idx}

Description

Get the key with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful inCallKey

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxPost

post /telephony/callBindings/{name}/softkey/{idx}

Description

Create a inCallKey setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull

Body Parameter

Name Description Required Default Pattern
inCallKeyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameSoftkeyIdxPut

put /telephony/callBindings/{name}/softkey/{idx}

Description

Update the key.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull

Body Parameter

Name Description Required Default Pattern
inCallKeyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyGet

get /telephony

Description

Get the telephony settings.


Responses

Status Code Message Response Schema
200 Operation successfull telephony

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyPut

put /telephony

Description

Update the telephony settings.

Body Parameter

Name Description Required Default Pattern
telephonyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TemplatesGet

get /templates

Description

Get all templates


Responses

Status Code Message Response Schema
200 A list of available key templates. array[template]

Response Schema

{
  "description" : "A list of available key templates.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    }
  }
}

TemplatesNameGet

get /templates/{name}

Description

Get the template with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the templateyesnull


Responses

Status Code Message Response Schema
200 Operation successful template

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TemplatesNamePut

put /templates/{name}

Description

Update the template with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the templateyesnull

Body Parameter

Name Description Required Default Pattern
templateyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TimeAndDateGet

get /timeAndDate

Description

Get the timeAndDate settings.


Responses

Status Code Message Response Schema
200 Operation successful timeAndDate

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TimeAndDatePut

put /timeAndDate

Description

Update the timeAndDate settings

Body Parameter

Name Description Required Default Pattern
timeAndDateyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UpdateGet

get /update

Description

Get the update settings.


Responses

Status Code Message Response Schema
200 Operation successful update

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UpdatePut

put /update

Description

Update the update settings.

Body Parameter

Name Description Required Default Pattern
updateyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceDisplayGet

get /userInterface/display

Description

Get the display settings.


Responses

Status Code Message Response Schema
200 Operation successful display

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceGet

get /userInterface

Description

Get settings for the user-interface.


Responses

Status Code Message Response Schema
200 Operation successful userInterface

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceKeypadGet

get /userInterface/keypad

Description

Get the keypad settings.


Responses

Status Code Message Response Schema
200 Operation successful keypad

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceKeypadPut

put /userInterface/keypad

Description

Update the keypad settings.

Body Parameter

Name Description Required Default Pattern
keypadThe keypad valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UserInterfaceLedsGet

get /userInterface/leds

Description

Get the led-settings.


Responses

Status Code Message Response Schema
200 Operation successful leds

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceLedsPut

put /userInterface/leds

Description

Update the led settings.

Body Parameter

Name Description Required Default Pattern
ledsThe led valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UserInterfaceMessagesGet

get /userInterface/messages

Description

Get the messages settings.


Responses

Status Code Message Response Schema
200 Operation successful messages

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfacePut

put /userInterface

Description

Update settings for the user-interface.

Body Parameter

Name Description Required Default Pattern
userInterfaceThe user-interface valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UsersGet

get /users

Description

Get a list of users


Responses

Status Code Message Response Schema
200 Operation successful array[user]

Response Schema

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

UsersNameDelete

delete /users/{name}

Description

Delete a user. The last user can not be deleted.

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersNameGet

get /users/{name}

Description

Returns a single user

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull


Responses

Status Code Message Response Schema
200 Operation successful user

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersNamePost

post /users/{name}

Description

Create a single user

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull

Body Parameter

Name Description Required Default Pattern
userThe user object to createyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}

UsersNamePut

put /users/{name}

Description

Update a single user

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull

Body Parameter

Name Description Required Default Pattern
userThe user properties to updateyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersPrimaryGet

get /users/primary

Description

Returns a single user


Responses

Status Code Message Response Schema
200 Operation successful user

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersPrimaryPut

put /users/primary

Description

Update a single user

Body Parameter

Name Description Required Default Pattern
userThe user properties to updateyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersUseraddPost

post /users/useradd

Description

Create a single user

Body Parameter

Name Description Required Default Pattern
userThe user object to createyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}

AppsGet

get /apps

Description

Get the apps-settings.


Responses

Status Code Message Response Schema
200 Operation successful apps

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AppsPut

put /apps

Description

Update the apps-settings.

Body Parameter

Name Description Required Default Pattern
appsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessAuthTokensGet

get /remoteAccess/authTokens

Description

Get the list of auth tokens


Responses

Status Code Message Response Schema
200 Operation successful array[authToken]

Response Schema

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

RemoteAccessAuthTokensIdxGet

get /remoteAccess/authTokens/{idx}

Description

Get the specified auth token at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the auth token.yesnull


Responses

Status Code Message Response Schema
200 Operation successful authToken

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessAuthTokensIdxPut

put /remoteAccess/authTokens/{idx}

Description

Update the auth token at the specified index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the auth token.yesnull

Body Parameter

Name Description Required Default Pattern
authTokenyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsGet

get /telephony/callBindings

Description

Get the CallBindings settings.


Responses

Status Code Message Response Schema
200 Operation successful array[callBinding]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameDelete

delete /telephony/callBindings/{name}

Description

Delete a call-binding by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameGet

get /telephony/callBindings/{name}

Description

Get the binding with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful callBinding

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNamePost

post /telephony/callBindings/{name}

Description

Create a CallBinding setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull

Body Parameter

Name Description Required Default Pattern
callBindingThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNamePut

put /telephony/callBindings/{name}

Description

Update the binding with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull

Body Parameter

Name Description Required Default Pattern
callBindingyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxGet

get /telephony/callBindings/{name}/softkey/{idx}

Description

Get the key with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful inCallKey

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

ContactListGet

get /contactList

Description

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


Responses

Status Code Message Response Schema
200 Operation successful array[contact]

Response Schema

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

ContactsDelete

delete /contacts

Description

Delete a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

ContactsGet

get /contacts

Description

Get a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful contacts

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPost

post /contacts

Description

Create a contacts setup

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPut

put /contacts

Description

Update a contacts settings

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for a ldap setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsDelete

delete /contacts

Description

Delete a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNameDelete

delete /devices/cameras/{name}

Description

Delete a camera by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberDelete

delete /keys/{group}/{keyNumber}

Description

Delete the key on the specified position in the group

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameDelete

delete /telephony/callBindings/{name}

Description

Delete a call-binding by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxDelete

delete /telephony/callBindings/{name}/softkey/{idx}

Description

Delete a call-key by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

UsersNameDelete

delete /users/{name}

Description

Delete a user. The last user can not be deleted.

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

DevicesGet

get /devices

Description

Get the Devices settings.


Responses

Status Code Message Response Schema
200 Operation successful devices

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesPost

post /devices

Description

Create a Devices setup

Body Parameter

Name Description Required Default Pattern
devicesThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesPut

put /devices

Description

Update a Devices setup.

Body Parameter

Name Description Required Default Pattern
devicesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

UserInterfaceDisplayGet

get /userInterface/display

Description

Get the display settings.


Responses

Status Code Message Response Schema
200 Operation successful display

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceLedsPut

put /userInterface/leds

Description

Update the led settings.

Body Parameter

Name Description Required Default Pattern
ledsThe led valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

RemoteAccessFilterSettingsGet

get /remoteAccess/filterSettings

Description

Get the 'filter settings' settings.


Responses

Status Code Message Response Schema
200 Operation successfull filterSettings

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessFilterSettingsPut

put /remoteAccess/filterSettings

Description

Update the 'filter settings' settings.

Body Parameter

Name Description Required Default Pattern
filterSettingsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AboutPhoneGet

get /aboutPhone

Description

Get the aboutPhone settings.


Responses

Status Code Message Response Schema
200 Operation successfull aboutPhone

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/aboutPhone"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AppsGet

get /apps

Description

Get the apps-settings.


Responses

Status Code Message Response Schema
200 Operation successful apps

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/apps"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactListGet

get /contactList

Description

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


Responses

Status Code Message Response Schema
200 Operation successful array[contact]

Response Schema

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

ContactsGet

get /contacts

Description

Get a contacts setup


Responses

Status Code Message Response Schema
200 Operation successful contacts

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/contacts"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasGet

get /devices/cameras

Description

Get the Cameras settings.


Responses

Status Code Message Response Schema
200 Operation successful array[ipCamera]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNameGet

get /devices/cameras/{name}

Description

Get the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful ipCamera

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesGet

get /devices

Description

Get the Devices settings.


Responses

Status Code Message Response Schema
200 Operation successful devices

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/devices"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

HomeScreenDesignGet

get /homeScreenDesign

Description

Get the home screen design


Responses

Status Code Message Response Schema
200 Operation successful homeScreenDesign

Response Schema

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

IdentitiesGet

get /identities

Description

Get the list of identities


Responses

Status Code Message Response Schema
200 Operation successful array[identity]

Response Schema

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

IdentitiesIdxGet

get /identities/{idx}

Description

Get the specified identity at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the identity.yesnull


Responses

Status Code Message Response Schema
200 Operation successful identity

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeyLayerGet

get /keyLayer

Description

Get the keylayer settings


Responses

Status Code Message Response Schema
200 Operation successful keyLayer

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeysGet

get /keys

Description

Get all configured keys


Responses

Status Code Message Response Schema
200 A list of all groups and their configured keys 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"
      }
    }
  }
}

KeysGroupGet

get /keys/{group}

Description

Get all keys for the specified group.

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull


Responses

Status Code Message Response Schema
200 Operation successful array[key]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberGet

get /keys/{group}/{keyNumber}

Description

Get the key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful key

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LocalesGet

get /locales

Description

Get the locale settings.


Responses

Status Code Message Response Schema
200 Operation successful locales

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LoggingGet

get /logging

Description

Get the logging settings.


Responses

Status Code Message Response Schema
200 Operation successful logging

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaAutoStartersGet

get /luaAutoStarters

Description

Get the luaAutoStarters settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaAutoStartersNameGet

get /luaAutoStarters/{name}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaScriptyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaConfigGet

get /luaConfig

Description

Get the luaConfig settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaConfigPair]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaConfigKeyGet

get /luaConfig/{key}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
keyThe name of the variableyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaConfigPair

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaLibrariesGet

get /luaLibraries

Description

Get the luaLibraries settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaLibrariesNameGet

get /luaLibraries/{name}

Description

Get the luaLibrary with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaLibraryyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

NetworkEthernetGet

get /network/ethernet

Description

Get the ethernet settings.


Responses

Status Code Message Response Schema
200 Operation successful ethernet

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkGet

get /network

Description

Get the network settings.


Responses

Status Code Message Response Schema
200 Operation successful network

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyGet

get /network/topology

Description

Get the topology settings.


Responses

Status Code Message Response Schema
200 Operation successful topology

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkVpnGet

get /network/vpn

Description

Get the vpn settings.


Responses

Status Code Message Response Schema
200 Operation successful vpn

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

PrivacyGet

get /privacy

Description

Fetch the telephones privacy settings


Responses

Status Code Message Response Schema
200 Operation successful privacy

Response Schema

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

ProvisioningGet

get /provisioning

Description

Get the provisionings settings.


Responses

Status Code Message Response Schema
200 Operation successful provisioning

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessAuthTokensGet

get /remoteAccess/authTokens

Description

Get the list of auth tokens


Responses

Status Code Message Response Schema
200 Operation successful array[authToken]

Response Schema

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

RemoteAccessAuthTokensIdxGet

get /remoteAccess/authTokens/{idx}

Description

Get the specified auth token at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the auth token.yesnull


Responses

Status Code Message Response Schema
200 Operation successful authToken

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/authToken"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessFilterSettingsGet

get /remoteAccess/filterSettings

Description

Get the 'filter settings' settings.


Responses

Status Code Message Response Schema
200 Operation successfull filterSettings

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/filterSettings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

RemoteAccessGet

get /remoteAccess

Description

Get the remote-access settings.


Responses

Status Code Message Response Schema
200 Operation successful remoteAccess

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/remoteAccess"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ResourcesGet

get /resources

Description

Fetch the additionally provisioned resources


Responses

Status Code Message Response Schema
200 Operation successful resources

Response Schema

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

SoundGet

get /sound

Description

Get the sound settings.


Responses

Status Code Message Response Schema
200 Operation successfull sound

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/sound"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsGet

get /telephony/callBindings

Description

Get the CallBindings settings.


Responses

Status Code Message Response Schema
200 Operation successful array[callBinding]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBindings"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameGet

get /telephony/callBindings/{name}

Description

Get the binding with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull


Responses

Status Code Message Response Schema
200 Operation successful callBinding

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/callBinding"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxGet

get /telephony/callBindings/{name}/softkey/{idx}

Description

Get the key with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful inCallKey

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/inCallKey"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyGet

get /telephony

Description

Get the telephony settings.


Responses

Status Code Message Response Schema
200 Operation successfull telephony

Response Schema

{
  "description" : "Operation successfull",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/telephony"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TemplatesGet

get /templates

Description

Get all templates


Responses

Status Code Message Response Schema
200 A list of available key templates. array[template]

Response Schema

{
  "description" : "A list of available key templates.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/templates"
      }
    }
  }
}

TemplatesNameGet

get /templates/{name}

Description

Get the template with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the templateyesnull


Responses

Status Code Message Response Schema
200 Operation successful template

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/template"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TimeAndDateGet

get /timeAndDate

Description

Get the timeAndDate settings.


Responses

Status Code Message Response Schema
200 Operation successful timeAndDate

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/timeAndDate"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UpdateGet

get /update

Description

Get the update settings.


Responses

Status Code Message Response Schema
200 Operation successful update

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/update"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceDisplayGet

get /userInterface/display

Description

Get the display settings.


Responses

Status Code Message Response Schema
200 Operation successful display

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/display"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceGet

get /userInterface

Description

Get settings for the user-interface.


Responses

Status Code Message Response Schema
200 Operation successful userInterface

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/userInterface"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceKeypadGet

get /userInterface/keypad

Description

Get the keypad settings.


Responses

Status Code Message Response Schema
200 Operation successful keypad

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceLedsGet

get /userInterface/leds

Description

Get the led-settings.


Responses

Status Code Message Response Schema
200 Operation successful leds

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceMessagesGet

get /userInterface/messages

Description

Get the messages settings.


Responses

Status Code Message Response Schema
200 Operation successful messages

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UsersGet

get /users

Description

Get a list of users


Responses

Status Code Message Response Schema
200 Operation successful array[user]

Response Schema

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

UsersNameGet

get /users/{name}

Description

Returns a single user

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull


Responses

Status Code Message Response Schema
200 Operation successful user

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

UsersPrimaryGet

get /users/primary

Description

Returns a single user


Responses

Status Code Message Response Schema
200 Operation successful user

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/user"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

HomeScreenDesignGet

get /homeScreenDesign

Description

Get the home screen design


Responses

Status Code Message Response Schema
200 Operation successful homeScreenDesign

Response Schema

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

HomeScreenDesignPut

put /homeScreenDesign

Description

Update the home screen design

Body Parameter

Name Description Required Default Pattern
homeScreenDesignyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

IdentitiesGet

get /identities

Description

Get the list of identities


Responses

Status Code Message Response Schema
200 Operation successful array[identity]

Response Schema

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

IdentitiesIdxGet

get /identities/{idx}

Description

Get the specified identity at the index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the identity.yesnull


Responses

Status Code Message Response Schema
200 Operation successful identity

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/identity"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

IdentitiesIdxPut

put /identities/{idx}

Description

Update the identity at the specified index.

Path Parameters

Name Description Required Default Pattern
idxThe index of the identity.yesnull

Body Parameter

Name Description Required Default Pattern
identityyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameSoftkeyIdxDelete

delete /telephony/callBindings/{name}/softkey/{idx}

Description

Delete a call-key by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

TelephonyCallBindingsNameSoftkeyIdxPost

post /telephony/callBindings/{name}/softkey/{idx}

Description

Create a inCallKey setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull

Body Parameter

Name Description Required Default Pattern
inCallKeyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameSoftkeyIdxPut

put /telephony/callBindings/{name}/softkey/{idx}

Description

Update the key.

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull

Body Parameter

Name Description Required Default Pattern
inCallKeyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasGet

get /devices/cameras

Description

Get the Cameras settings.


Responses

Status Code Message Response Schema
200 Operation successful array[ipCamera]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCameras"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNameDelete

delete /devices/cameras/{name}

Description

Delete a camera by name

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNameGet

get /devices/cameras/{name}

Description

Get the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull


Responses

Status Code Message Response Schema
200 Operation successful ipCamera

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ipCamera"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNamePost

post /devices/cameras/{name}

Description

Create a Camera setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCameraThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNamePut

put /devices/cameras/{name}

Description

Update the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCamerayes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeyLayerGet

get /keyLayer

Description

Get the keylayer settings


Responses

Status Code Message Response Schema
200 Operation successful keyLayer

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keyLayer"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeyLayerPut

put /keyLayer

Description

Set the keylayer settings

Body Parameter

Name Description Required Default Pattern
keyLayerThe keyLayer valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UserInterfaceKeypadGet

get /userInterface/keypad

Description

Get the keypad settings.


Responses

Status Code Message Response Schema
200 Operation successful keypad

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/keypad"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UserInterfaceKeypadPut

put /userInterface/keypad

Description

Update the keypad settings.

Body Parameter

Name Description Required Default Pattern
keypadThe keypad valuesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

KeysGet

get /keys

Description

Get all configured keys


Responses

Status Code Message Response Schema
200 A list of all groups and their configured keys 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"
      }
    }
  }
}

KeysGroupGet

get /keys/{group}

Description

Get all keys for the specified group.

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull


Responses

Status Code Message Response Schema
200 Operation successful array[key]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/groupedKeys"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberDelete

delete /keys/{group}/{keyNumber}

Description

Delete the key on the specified position in the group

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberGet

get /keys/{group}/{keyNumber}

Description

Get the key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull


Responses

Status Code Message Response Schema
200 Operation successful key

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/key"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPost

post /keys/{group}/{keyNumber}

Description

Create a new key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull

Body Parameter

Name Description Required Default Pattern
keyThe config values for the keyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPut

put /keys/{group}/{keyNumber}

Description

Update the key on the specified position in the group

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull

Body Parameter

Name Description Required Default Pattern
keyThe updated configuration for the keyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

UserInterfaceLedsGet

get /userInterface/leds

Description

Get the led-settings.


Responses

Status Code Message Response Schema
200 Operation successful leds

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/leds"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LocalesGet

get /locales

Description

Get the locale settings.


Responses

Status Code Message Response Schema
200 Operation successful locales

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/locales"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LocalesPut

put /locales

Description

Update the locale settings.

Body Parameter

Name Description Required Default Pattern
localesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LoggingGet

get /logging

Description

Get the logging settings.


Responses

Status Code Message Response Schema
200 Operation successful logging

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/logging"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LoggingPut

put /logging

Description

Set the logging settings.

Body Parameter

Name Description Required Default Pattern
loggingyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}

LuaAutoStartersGet

get /luaAutoStarters

Description

Get the luaAutoStarters settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaAutoStarters"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaAutoStartersNameGet

get /luaAutoStarters/{name}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaScriptyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaAutoStartersNamePut

put /luaAutoStarters/{name}

Description

Update the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaScriptyesnull

Body Parameter

Name Description Required Default Pattern
luaScriptyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaConfigGet

get /luaConfig

Description

Get the luaConfig settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaConfigPair]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfig"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaConfigKeyGet

get /luaConfig/{key}

Description

Get the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
keyThe name of the variableyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaConfigPair

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaConfigPair"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaConfigKeyPut

put /luaConfig/{key}

Description

Update the luaScript with the specified name.

Path Parameters

Name Description Required Default Pattern
keyThe name of the variableyesnull

Body Parameter

Name Description Required Default Pattern
luaConfigPairyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaLibrariesGet

get /luaLibraries

Description

Get the luaLibraries settings.


Responses

Status Code Message Response Schema
200 Operation successful array[luaScript]

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaLibraries"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

LuaLibrariesNameGet

get /luaLibraries/{name}

Description

Get the luaLibrary with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaLibraryyesnull


Responses

Status Code Message Response Schema
200 Operation successful luaScript

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/luaScript"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

LuaLibrariesNamePut

put /luaLibraries/{name}

Description

Update the luaLibrary with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the luaLibraryyesnull

Body Parameter

Name Description Required Default Pattern
luaScriptyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

UserInterfaceMessagesGet

get /userInterface/messages

Description

Get the messages settings.


Responses

Status Code Message Response Schema
200 Operation successful messages

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/messages"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkEthernetGet

get /network/ethernet

Description

Get the ethernet settings.


Responses

Status Code Message Response Schema
200 Operation successful ethernet

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/ethernet"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkEthernetPut

put /network/ethernet

Description

Update the ethernet settings.

Body Parameter

Name Description Required Default Pattern
ethernetyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkGet

get /network

Description

Get the network settings.


Responses

Status Code Message Response Schema
200 Operation successful network

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/network"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkPut

put /network

Description

Update the network settings.

Body Parameter

Name Description Required Default Pattern
networkyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyGet

get /network/topology

Description

Get the topology settings.


Responses

Status Code Message Response Schema
200 Operation successful topology

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/topology"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyPost

post /network/topology

Description

Create a Topology setup

Body Parameter

Name Description Required Default Pattern
topologyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkTopologyPut

put /network/topology

Description

Update the topology settings.

Body Parameter

Name Description Required Default Pattern
topologyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkVpnGet

get /network/vpn

Description

Get the vpn settings.


Responses

Status Code Message Response Schema
200 Operation successful vpn

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/vpn"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

NetworkVpnPut

put /network/vpn

Description

Update the vpn settings.

Body Parameter

Name Description Required Default Pattern
vpnyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPost

post /contacts

Description

Create a contacts setup

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNamePost

post /devices/cameras/{name}

Description

Create a Camera setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCameraThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesPost

post /devices

Description

Create a Devices setup

Body Parameter

Name Description Required Default Pattern
devicesThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

KeysGroupKeyNumberPost

post /keys/{group}/{keyNumber}

Description

Create a new key on the specified position

Path Parameters

Name Description Required Default Pattern
groupThe group the key belongs to.yesnull keyNumberThe position of the key in the specified group.yesnull

Body Parameter

Name Description Required Default Pattern
keyThe config values for the keyyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

NetworkTopologyPost

post /network/topology

Description

Create a Topology setup

Body Parameter

Name Description Required Default Pattern
topologyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNamePost

post /telephony/callBindings/{name}

Description

Create a CallBinding setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull

Body Parameter

Name Description Required Default Pattern
callBindingThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

TelephonyCallBindingsNameSoftkeyIdxPost

post /telephony/callBindings/{name}/softkey/{idx}

Description

Create a inCallKey setup

Path Parameters

Name Description Required Default Pattern
nameThe name of the bindingyesnull idxThe index of the keyyesnull

Body Parameter

Name Description Required Default Pattern
inCallKeyThe setting values for this setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

UsersNamePost

post /users/{name}

Description

Create a single user

Path Parameters

Name Description Required Default Pattern
nameThe name of the user to fetchyesnull

Body Parameter

Name Description Required Default Pattern
userThe user object to createyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}

UsersUseraddPost

post /users/useradd

Description

Create a single user

Body Parameter

Name Description Required Default Pattern
userThe user object to createyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}

PrivacyGet

get /privacy

Description

Fetch the telephones privacy settings


Responses

Status Code Message Response Schema
200 Operation successful privacy

Response Schema

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

PrivacyPut

put /privacy

Description

Update privacy settings

Body Parameter

Name Description Required Default Pattern
privacyThe privacy settingsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
404 Not Found

Response Schema

{
  "description" : "Not Found"
}

ProvisioningGet

get /provisioning

Description

Get the provisionings settings.


Responses

Status Code Message Response Schema
200 Operation successful provisioning

Response Schema

{
  "description" : "Operation successful",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    },
    "application/xml" : {
      "schema" : {
        "$ref" : "#/components/schemas/provisioning"
      }
    }
  }
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ProvisioningPut

put /provisioning

Description

Update the provisioning settings.

Body Parameter

Name Description Required Default Pattern
provisioningyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AboutPhonePut

put /aboutPhone

Description

Update the aboutPhone settings.

Body Parameter

Name Description Required Default Pattern
aboutPhoneyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

AppsPut

put /apps

Description

Update the apps-settings.

Body Parameter

Name Description Required Default Pattern
appsyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

ContactsPut

put /contacts

Description

Update a contacts settings

Body Parameter

Name Description Required Default Pattern
contactsThe setting values for a ldap setupyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

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

DevicesCamerasNamePut

put /devices/cameras/{name}

Description

Update the camera with the specified name.

Path Parameters

Name Description Required Default Pattern
nameThe name of the camerayesnull

Body Parameter

Name Description Required Default Pattern
ipCamerayes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Invalid request. AppError

Response Schema

{
  "description" : "Invalid request.",
  "content" : {
    "application/json" : {
      "schema" : {
        "$ref" : "#/components/schemas/AppError"
      }
    }
  }
}
Status Code Message Response Schema
401 Unauthorized

Response Schema

{
  "description" : "Unauthorized"
}
Status Code Message Response Schema
403 Forbidden

Response Schema

{
  "description" : "Forbidden"
}
Status Code Message Response Schema
404 NotFound

Response Schema

{
  "description" : "NotFound"
}

DevicesPut

put /devices

Description

Update a Devices setup.

Body Parameter

Name Description Required Default Pattern
devicesyes


Responses

Status Code Message Response Schema
200 Operation successful

Response Schema

{
  "description" : "Operation successful"
}
Status Code Message Response Schema
400 Inva