D-Serie API#

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

Version: 1.0.0

Endpoint overview#

ContactsApi#

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

DisplayApi#

get / UserInterfaceDisplayGet: Get the display settings.
put / UserInterfaceDisplayPut: Update the display settings.

IdentitiesApi#

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

KeyLayerApi#

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

KeysApi#

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

LocalesApi#

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

LoggingApi#

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

LuaLibrariesApi#

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

NetworkApi#

get / NetworkEthernetGet: Get the ethernet settings.
put / NetworkEthernetPut: Update the ethernet settings.
get / NetworkGet: Get the network settings.

ProvisioningApi#

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

RemoteAccessApi#

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

SoundApi#

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

TelephonyApi#

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

TemplatesApi#

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

TimeAndDateApi#

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

UpdateApi#

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

UserInterfaceApi#

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

UsersApi#

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

Endpoint List#

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](#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](#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](#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
contacts	The setting values for a contacts setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
contacts	The setting values for a ldap setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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
idx	The index of the identity.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[identity](#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](#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
idx	The index of the identity.	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
identity	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
keyLayer	The keyLayer values	yes
\
#### 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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[key](#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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[key](#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](#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
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The config values for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The updated configuration for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
locales	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
logging	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

LuaLibrariesGet#

get /luaLibraries

Description#

Get the luaLibraries settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[luaLibrary](#lualibrary)%%]%%`''

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](#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
name	The name of the luaLibrary	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[luaLibrary](#lualibrary)`

Response Schema

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

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
name	The name of the luaLibrary	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
luaLibrary	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
ethernet	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#apperror) |

Response Schema

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

ProvisioningGet#

get /provisioning

Description#

Get the provisionings settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[provisioning](#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](#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
provisioning	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
remoteAccess	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

SoundGet#

get /sound

Description#

Get the sound settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[sound](#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](#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
sound	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

TelephonyGet#

get /telephony

Description#

Get the telephony settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[telephony](#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](#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
telephony	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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
name	The name of the template	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[template](#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](#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
name	The name of the template	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
template	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
timeAndDate	yes
\
#### 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](#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](#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
update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#apperror) |

Response Schema

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

UserInterfaceDisplayPut#

put /userInterface/display

Description#

Update the display settings.

Body Parameter#

Name	Description	Required
display	The display values	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UserInterfaceGet#

get /userInterface

Description#

Get settings for the user-interface.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[userInterface](#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](#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
userInterface	The user-interface values	yes
\
#### 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](#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
name	The name of the user to fetch	yes	null
\
#### 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
name	The name of the user to fetch	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[user](#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
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user object to create	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user properties to update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

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](#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](#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](#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
contacts	The setting values for a contacts setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
contacts	The setting values for a ldap setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
name	The name of the user to fetch	yes	null
\
#### 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"
}

UserInterfaceDisplayGet#

get /userInterface/display

Description#

Get the display settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[display](#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](#apperror) |

Response Schema

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

UserInterfaceDisplayPut#

put /userInterface/display

Description#

Update the display settings.

Body Parameter#

Name	Description	Required
display	The display values	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

ContactsGet#

get /contacts

Description#

Get a contacts setup

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[contacts](#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](#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](#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
idx	The index of the identity.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[identity](#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](#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](#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](#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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[key](#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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[key](#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](#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](#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](#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](#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](#apperror) |

Response Schema

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

LuaLibrariesGet#

get /luaLibraries

Description#

Get the luaLibraries settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[luaLibrary](#lualibrary)%%]%%`''

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](#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
name	The name of the luaLibrary	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[luaLibrary](#lualibrary)`

Response Schema

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

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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](#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](#apperror) |

Response Schema

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

ProvisioningGet#

get /provisioning

Description#

Get the provisionings settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[provisioning](#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](#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](#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](#apperror) |

Response Schema

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

SoundGet#

get /sound

Description#

Get the sound settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[sound](#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](#apperror) |

Response Schema

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

TelephonyGet#

get /telephony

Description#

Get the telephony settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[telephony](#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](#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](#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
name	The name of the template	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[template](#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](#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](#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](#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](#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](#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](#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](#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](#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](#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](#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
name	The name of the user to fetch	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[user](#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"
}

IdentitiesGet#

get /identities

Description#

Get the list of identities

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[identity](#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
idx	The index of the identity.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[identity](#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](#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
idx	The index of the identity.	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
identity	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
keyLayer	The keyLayer values	yes
\
#### 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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[key](#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](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
group	The group the key belongs to.	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[key](#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](#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
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The config values for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The updated configuration for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
locales	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
logging	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

LuaLibrariesGet#

get /luaLibraries

Description#

Get the luaLibraries settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`''array%%[%%[luaLibrary](#lualibrary)%%]%%`''

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](#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
name	The name of the luaLibrary	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[luaLibrary](#lualibrary)`

Response Schema

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

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
name	The name of the luaLibrary	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
luaLibrary	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
ethernet	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
contacts	The setting values for a contacts setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The config values for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

UsersNamePost#

post /users/{name}

Description#

Create a single user

Path Parameters#

Name	Description	Required	Default	Pattern
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user object to create	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

ProvisioningGet#

get /provisioning

Description#

Get the provisionings settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[provisioning](#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](#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
provisioning	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
contacts	The setting values for a ldap setup	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
idx	The index of the identity.	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
identity	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
keyLayer	The keyLayer values	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

KeysGroupKeyNumberPut#

put /keys/{group}/{keyNumber}

Description#

Update the key on the specified position in the group

Path Parameters#

Name	Description	Required	Default	Pattern
group	The group the key belongs to.	yes	null
#### Body Parameter

Name	Description	Required
key	The updated configuration for the key	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

LocalesPut#

put /locales

Description#

Update the locale settings.

Body Parameter#

Name	Description	Required	Default	Pattern
locales	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
logging	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

LuaLibrariesNamePut#

put /luaLibraries/{name}

Description#

Update the luaLibrary with the specified name.

Path Parameters#

Name	Description	Required	Default	Pattern
name	The name of the luaLibrary	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
luaLibrary	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

NetworkEthernetPut#

put /network/ethernet

Description#

Update the ethernet settings.

Body Parameter#

Name	Description	Required	Default	Pattern
ethernet	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
provisioning	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
remoteAccess	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
sound	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
telephony	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

TemplatesNamePut#

put /templates/{name}

Description#

Update the template with the specified name.

Path Parameters#

Name	Description	Required	Default	Pattern
name	The name of the template	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
template	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

TimeAndDatePut#

put /timeAndDate

Description#

Update the timeAndDate settings

Body Parameter#

Name	Description	Required	Default	Pattern
timeAndDate	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UpdatePut#

put /update

Description#

Update the update settings.

Body Parameter#

Name	Description	Required	Default	Pattern
update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

UserInterfaceDisplayPut#

put /userInterface/display

Description#

Update the display settings.

Body Parameter#

Name	Description	Required
display	The display values	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UserInterfacePut#

put /userInterface

Description#

Update settings for the user-interface.

Body Parameter#

Name	Description	Required
userInterface	The user-interface values	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

UsersNamePut#

put /users/{name}

Description#

Update a single user

Path Parameters#

Name	Description	Required	Default	Pattern
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user properties to update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

RemoteAccessGet#

get /remoteAccess

Description#

Get the remote-access settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successful	`[remoteAccess](#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](#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
remoteAccess	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

SoundGet#

get /sound

Description#

Get the sound settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[sound](#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](#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
sound	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#apperror) |

Response Schema

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

TelephonyGet#

get /telephony

Description#

Get the telephony settings.

\

Responses#

Status Code	Message	Response Schema
200	Operation successfull	`[telephony](#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](#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
telephony	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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
name	The name of the template	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[template](#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](#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
name	The name of the template	yes	null
#### Body Parameter

Name	Description	Required	Default	Pattern
template	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
timeAndDate	yes
\
#### 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](#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](#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
update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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](#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](#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
userInterface	The user-interface values	yes
\
#### 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](#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
name	The name of the user to fetch	yes	null
\
#### 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
name	The name of the user to fetch	yes	null
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful	`[user](#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
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user object to create	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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
name	The name of the user to fetch	yes	null
#### Body Parameter

Name	Description	Required
user	The user properties to update	yes
\
#### Responses

Status Code	Message	Response Schema
200	Operation successful

Response Schema

{
  "description" : "Operation successful"
}

| Status Code | Message | Response Schema | | --------------- | ----------- | ------------------- | | 400 | Invalid request. | [AppError](#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"
}

Models#

AppError#

Field Name	Required	Type
code	no	`Integer`
message	no	`String`
requestUnderscoreid	no	`String`

BundleKey#

Field Name	Required	Type	Description
name	yes	`String`

CallForwarding#

Field Name	Required	Type
unconditional	no	callForwardingMethod
busy	no	callForwardingMethod
noResponse	no	callForwardingMethod

CallForwardingMethod#

Field Name	Required	Type	Description
active	yes	`Boolean`	enables call forwarding
target	yes	`String`
timeout	no	`Integer`	the time [s] after which the call must be forwarded

CallWaiting#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the function callWaiting
tone	no	`Boolean`	enables the signalisation of a waiting call

Clir#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the function clir

Contacts#

Field Name	Required	Type	Description
ldap	no	ldap

Display#

Field Name	Required	Type	Description
timeout	no	`Integer`	Time till lockscreen appears on no activity. Measured in milliseconds. -1 = never
contrast	no	`Integer`
brightness	no	`Integer`

DoNotDisturb#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the function doNotDisturb

Ethernet#

Field Name	Required	Type
ipv4	no	ipv4
ipv6	no	ipv6
vlan	no	vlan

ExecutionTime#

Field Name	Required	Type	Description
mondays	no	`Boolean`
tuesdays	no	`Boolean`
wednesdays	no	`Boolean`
thursdays	no	`Boolean`
fridays	no	`Boolean`
saturdays	no	`Boolean`
sundays	no	`Boolean`
time	no	`String`	a time in HH:MM format

HttpHeader#

Field Name	Required	Type	Description
header	no	`String`
value	no	`String`

HttpReactionResponseCode#

Field Name	Required	Type	Description
responseCode	no	`Integer`
dialogMessage	no	`String`	Creates a message dialog on the screen.
ledColor	no	`ledColor`
ledBlinking	no	`Boolean`	Whether the LED should blink or not.

HttpReactionResponseCodeAllOf#

Field Name	Required	Type	Description
responseCode	no	`Integer`
dialogMessage	no	`String`	Creates a message dialog on the screen.

HttpReactionResponseHeader#

Field Name	Required	Type	Description
dialogMessage	no	`String`	Creates a message dialog on the screen.
ledColor	no	`ledColor`
ledBlinking	no	`Boolean`	Whether the LED should blink or not.
header	no	`String`
value	no	`String`

HttpReactionResponseHeaderAllOf#

Field Name	Required	Type	Description
dialogMessage	no	`String`	Creates a message dialog on the screen.

HttpRequest#

Field Name	Required	Type	Description
httpHeader	no	httpHeader
httpMethod	yes	`httpMethod`
uri	no	`String`
httpContent	no	`String`	The content of an HTTP request

Identity#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the identity for registration
username	no	`String`	The user part of a SIP URI to register the identity
password	no	`String`	The password to authenticate the identity register
displayname	no	`String`	The display name of the identity
host	no	`String`	The host part of the identity
frameSize	no	`Integer`	rtp frame size in milliseconds (typically 10, 20 or 30 ms)
dialplan	no	`array%%[%%[rule](#rule)%%]%%`
audiocodecs	no	`array[audiocodec]`
clir	no	`clirType`
vmb	no	`String`	The sip-username where the phone should subscribe to to get information about voice-messages. It is also used to make the call when trying to access these messages.
localmoh	no	`Boolean`	plays local music on hold if a call of this identity is set on hold. When enabled, held calls will take away one audio-channel. Since our phones only have 2 channels, this will limit the number of simultanious calls to two.
secureConnection	no	`Boolean`	Activates sips (SIP over TLS) on connections with this identity. Most likely you have to provide a certificate for the host you provided to be able to connect safely and successfully.
srtp	no	`srtpMode`
checkHostname	no	`Boolean`	Validate the hostname against the CN of the provided Certificate.
sipOverTls	no	`Boolean`	Use SIP over TLS. If deactivated sips: scheme is used
certificate	no	`String`	Root certificate used as a trust anchor for the host. Text in PEM format.
pickupCode	no	`String`	used as pre code for the user part in an invite URI in case of a pickup szenario. e.g. '##06'
ipVersion	no	`ipVersion`
jitterBufferSize	no	`Integer`
value allows a more robust communication when there are network issues.

Ipv4#

Field Name	Required	Type
mode	yes	`ipv4mode`
address	no	`String`
netmask	no	`String`
gateway	no	`String`
dns1	no	`String`
dns2	no	`String`

Ipv6#

Field Name	Required	Type
mode	yes	`ipv6mode`
dns1	no	`String`
dns2	no	`String`

Key#

Field Name	Required	Type	Description
keyNumber	yes	`Integer`	The number of the key
label	no	`String`	The name of the key
keyConfiguration	no	keyConfiguration
templateName	no	`String`	Reference to the text element of the template name.

KeyConfiguration#

Field Name	Required	Type
lua	no	luaContent
line	no	line
function	no	`keyFunction`

KeyConfigurationOneOf#

Field Name	Required	Type	Description
lua	no	luaContent

KeyConfigurationOneOf1#

Field Name	Required	Type	Description
line	no	line

KeyConfigurationOneOf2#

Field Name	Required	Type	Description
function	no	`keyFunction`

KeyHttpRequest#

Field Name	Required	Type	Description
request	no	httpRequest
httpReactions	no	`array[oneOf<httpReactionResponseCode,httpReactionResponseHeader>]`

KeyHttpRequestAllOf#

Field Name	Required	Type	Description
request	no	httpRequest

KeyHttpRequestAllOf1#

Field Name	Required	Type	Description
httpReactions	no	`array[oneOf<httpReactionResponseCode,httpReactionResponseHeader>]`

KeyIntent#

Field Name	Required	Type	Description
action	yes	`String`
data	no	`String`
component	no	`String`
extras	no	`array[oneOf<object,object,object>]`	A map of `'string': bool %% \| %% int %% \| %% string`

KeyInvite#

Field Name	Required	Type	Description
uri	yes	`String`
line	no	line

KeyInvocation#

Field Name	Required	Type	Description
http	no	keyHttpRequest
setting	no	keySetting
dialog	no	`String`	Creates a message dialog on the screen.
invite	no	keyInvite
intent	no	keyIntent

KeyInvocationOneOf#

Field Name	Required	Type	Description
http	no	keyHttpRequest

KeyInvocationOneOf1#

Field Name	Required	Type	Description
setting	no	keySetting

KeyInvocationOneOf2#

Field Name	Required	Type	Description
dialog	no	`String`	Creates a message dialog on the screen.

KeyInvocationOneOf3#

Field Name	Required	Type	Description
invite	no	keyInvite

KeyInvocationOneOf4#

Field Name	Required	Type	Description
intent	no	keyIntent

KeyLayer#

Field Name	Required	Type
phoneXtensions	no	`Integer`
extensionModule1	no	`Integer`
extensionModule2	no	`Integer`
extensionModule3	no	`Integer`

KeyReaction#

Field Name	Required	Type	Description
ledSetting	no	ledSetting
presence	no	presence

KeyReactionOneOf#

Field Name	Required	Type	Description
ledSetting	no	ledSetting

KeyReactionOneOf1#

Field Name	Required	Type	Description
presence	no	presence

KeySetting#

Field Name	Required	Type
path	yes	`String`
values	no	`array[Object]`
other	no	ledSetting

Keys#

Field Name	Required	Type	Description
phoneXtensions	no	`array%%[%%[key](#key)%%]%%`	On D-400/D-600: 60 virtual Xtension keys. On D-100/D-200: 18 (3x6) self-labeling Xtension keys.
extensionModule1	no	`array%%[%%[key](#key)%%]%%`	60 Xtension keys on an extension module.
extensionModule2	no	`array%%[%%[key](#key)%%]%%`	60 Xtension keys on an extension module.
extensionModule3	no	`array%%[%%[key](#key)%%]%%`	60 Xtension keys on an extension module.
homeScreen	no	`array%%[%%[key](#key)%%]%%`	4 keys below the display

Ldap#

Field Name	Required	Type	Description
active	no	`Boolean`	use this service or not
server	yes	`String`	ldap server address fqdn or ip address
ldapProtocol	no	`ldapProtocol`
port	no	`Integer`	ldap server port 389 or 636 (LDAPS)
ldapVersion	no	`ldapVersion`
username	yes	`String`	username to login
password	yes	`String`	The password to authenticate the for the ldap server
nameFilter	no	`String`	name filter according to RFC2254
numberFilter	no	`String`	number filter according to RFC2254 for reverse number lookup
dialerNumberFilter	no	`String`	number filter according to RFC2254 for the number suggestion list in the dialer
baseDN	no	`String`	in what scope will be used searched
maxHits	no	`Integer`	maximum result entries
nameAttributes	no	`String`	what names are you looking for
numberAttributes	no	`String`	what numbers are you looking for
orderBy	no	`orderNameBy`
reverseNumberLookupIncoming	no	`Boolean`	find contact by incoming call number
reverseNumberLookupOutgoing	no	`Boolean`	find contact by outgoing call number

LedSetting#

Field Name	Required	Type	Description
ledColor	no	`ledColor`
ledBlinking	no	`Boolean`	Whether the LED should blink or not.

Line#

Field Name	Required	Type	Description
id	yes	`String`
component	no	`String`

Locales#

Field Name	Required	Type
deviceLanguage	no	`language`
webserverLanguage	no	`language`
deviceLocation	no	`locale`

Logging#

Field Name	Required	Type	Description
remotes	no	`array%%[%%[remoteLog](#remotelog)%%]%%`

LuaContent#

Field Name	Required	Type	Description
code	yes	`String`	Lua code to be executed for functionkeys.
params	no	`array%%[%%[luaParam](#luaparam)%%]%%`

LuaLibrary#

Field Name	Required	Type	Description
name	no	`String`
code	no	`String`	Lua code to be executed for functionkeys.

LuaParam#

Field Name	Required	Type	Description
name	yes	`String`
value	no	`String`

Messages#

Field Name	Required	Type	Description
signalSeenMissedCalls	no	`msgSignalisation`
signalOldMailboxMessages	no	`msgSignalisation`

Network#

Field Name	Required	Type	Description
ethernet	no	ethernet

Parameter#

Field Name	Required	Type	Description
path	yes	`array[String]`	List of XPath elements within the key structure.
name	no	`String`
description	no	`String`
optional	no	`Boolean`
choice	no	`array[String]`
mode	no	`tmpParamModeEnum`

Presence#

Field Name	Required	Type	Description
subscribe	yes	subscribe

Provisioning#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the provisioning
dhcp	no	`Boolean`	checks the dhcp fields 66 and 67 for an provisioning url
redirect	no	`Boolean`	checks for a provisioning redirection on connect.redirect.auerswald.de
pbx	no	`Boolean`	checks via properitary sip-multicast extension for an provisioning url
url	no	`String`
sip	no	sipProvisioning
execution	no	executionTime

RemoteAccess#

Field Name	Required	Type	Description
webd	no	`Boolean`	enable remote access via http(s)
adbd	no	`Boolean`	enable remote access via adb

RemoteLog#

Field Name	Required	Type	Description
server	yes	`String`	Hostname of the log server
port	yes	`Integer`	Port of the log server
protocol	yes	`logProtocol`
filter	no	`String`	Filter to use for logging. A space-separated list of TAG[:Priority]. TAG can be \"*\" for all, Priority can be one of S:silent E:error W:warning I:info D:debug V:verbose. Default priority if omitted is [V]erbose.

ReverseNumberLookup#

Field Name	Required	Type	Description
active	no	`Boolean`	enables the function reverse phone number lookup

Rule#

Field Name	Required	Type	Description
pattern	yes	`String`
replace	yes	`String`

SipProvisioning#

Field Name	Required	Type	Description
active	no	`Boolean`	allows provisioning via sip
whitelist	no	`array[String]`

Sound#

Field Name	Required	Type	Description
defaultRingtone	no	`ringtone`
volumes	no	volumes

Field Name	Required	Type	Description
uri	yes	`String`
line	no	line
listenFor	no	`String`	If the subscribeType is dialog, you can specify here what to listen for. In every other case, this option is ignored.
type	yes	`subscribeType`

Telephony#

Field Name	Required	Type	Description
callWaiting	no	callWaiting
doNotDisturb	no	doNotDisturb
callForwarding	no	callForwarding
clir	no	clir
reverseNumberLookup	no	reverseNumberLookup
defaultAudioDevice	no	`audioDevice`
activeLine	no	line
callStartTimeout	no	`Integer`	Time delay to start the call when there is no activity. Measured in milliseconds. -1 = never
callAcceptTimeout	no	`Integer`	Time delay to accept an incoming call automatically. Measured in milliseconds. -1 = never

Template#

Field Name	Required	Type	Description
name	yes	`String`	Text identifying the Template. Has to be unique. Will be referenced in key structure to store which template was used. Free usable text or android resource tag
prio	no	`Integer`	sort with prio
description	no	`String`
keyConfiguration	yes	keyConfiguration
parameters	no	`array%%[%%[parameter](#parameter)%%]%%`

TimeAndDate#

Field Name	Required	Type
ntpEnable	no	`Boolean`
ntpServer	no	`String`
timezone	no	`timezone`
timeHourFormat	no	`timeHourFormat`

Update#

Field Name	Required	Type	Description
check	no	`Boolean`	check for updates
autoInstall	no	`Boolean`	automatically install updates if available
url	no	`String`
execution	no	executionTime

User#

Field Name	Required	Type	Description
name	yes	`String`	The name of the user is at the same time the unique id.
password	yes	`String`	The password for the user. If the password is provisioned, you have to supply a hashed password. You can create a compatible hash using the tool provided in the web interface at the following url: `https:%%/%%/<Your-IP>/#/generateHash`. Over the api, you send the password over HTTPS in clear text, where it gets hashed in the webserver.
role	yes	`role`
image	no	`byte[]`	The image for the user, base64 encoded. The image should not exceed 300x300px.
changePassword	no	`Boolean`	Indicates wether a user has to change his password. This flag will only be evaluated by client side logins and any tool handling the login should honour it.

UserInterface#

Field Name	Required	Type	Description
display	no	display
messages	no	messages

Vlan#

Field Name	Required	Type
phoneActive	no	`Boolean`
phoneId	no	`Integer`
phonePriority	no	`Integer`
workstationActive	no	`Boolean`
workstationId	no	`Integer`
workstationPriority	no	`Integer`

Volumes#

Field Name	Required	Type	Description
ringing	no	`Integer`	volume to use when phone is ringing
headset	no	`Integer`	volume-level used to play audio via headset
speaker	no	`Integer`	volume-level used to play audio via speaker
handset	no	`Integer`	volume-level used to play audio via handset