Release 2.2A API#

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

Version: 1.23.13

Endpoint overview#

AboutPhoneApi#

• get / [[#AboutPhoneGet|AboutPhoneGet]]: Get the aboutPhone settings.
• put / [[#AboutPhonePut|AboutPhonePut]]: Update the aboutPhone settings.

AppsApi#

• get / [[#AppsGet|AppsGet]]: Get the apps-settings.
• put / [[#AppsPut|AppsPut]]: Update the apps-settings.

AuthTokensApi#

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

CallBindingsApi#

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

ContactListApi#

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

ContactsApi#

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

DevicesApi#

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

DisplayApi#

• get / [[#UserInterfaceDisplayGet|UserInterfaceDisplayGet]]: Get the display settings.
• put / [[#UserInterfaceLedsPut|UserInterfaceLedsPut]]: Update the led settings.

FilterSettingsApi#

• get / [[#RemoteAccessFilterSettingsGet|RemoteAccessFilterSettingsGet]]: Get the 'filter settings' settings.
• put / [[#RemoteAccessFilterSettingsPut|RemoteAccessFilterSettingsPut]]: Update the 'filter settings' settings.

HomeScreenDesignApi#

• get / [[#HomeScreenDesignGet|HomeScreenDesignGet]]: Get the home screen design
• put / [[#HomeScreenDesignPut|HomeScreenDesignPut]]: Update the home screen design

IdentitiesApi#

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

InCallKeysApi#

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

IpCamerasApi#

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

KeyLayerApi#

• get / [[#KeyLayerGet|KeyLayerGet]]: Get the keylayer settings
• put / [[#KeyLayerPut|KeyLayerPut]]: Set the keylayer settings

KeypadApi#

• get / [[#UserInterfaceKeypadGet|UserInterfaceKeypadGet]]: Get the keypad settings.
• put / [[#UserInterfaceKeypadPut|UserInterfaceKeypadPut]]: Update the keypad settings.

KeysApi#

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

LedsApi#

• get / [[#UserInterfaceLedsGet|UserInterfaceLedsGet]]: Get the led-settings.

LocalesApi#

• get / [[#LocalesGet|LocalesGet]]: Get the locale settings.
• put / [[#LocalesPut|LocalesPut]]: Update the locale settings.

LoggingApi#

• get / [[#LoggingGet|LoggingGet]]: Get the logging settings.
• put / [[#LoggingPut|LoggingPut]]: Set the logging settings.

LuaAutoStartersApi#

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

LuaConfigApi#

• get / [[#LuaConfigGet|LuaConfigGet]]: Get the luaConfig settings.

LuaConfigPairApi#

• get / [[#LuaConfigKeyGet|LuaConfigKeyGet]]: Get the luaScript with the specified name.
• put / [[#LuaConfigKeyPut|LuaConfigKeyPut]]: Update the luaScript with the specified name.

LuaLibrariesApi#

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

MessagesApi#

• get / [[#UserInterfaceMessagesGet|UserInterfaceMessagesGet]]: Get the messages settings.

NetworkApi#

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

PrivacyApi#

• get / [[#PrivacyGet|PrivacyGet]]: Fetch the telephones privacy settings
• put / [[#PrivacyPut|PrivacyPut]]: Update privacy settings

ProvisioningApi#

• get / [[#ProvisioningGet|ProvisioningGet]]: Get the provisionings settings.
• put / [[#ProvisioningPut|ProvisioningPut]]: Update the provisioning settings.

RemoteAccessApi#

• get / [[#RemoteAccessGet|RemoteAccessGet]]: Get the remote-access settings.
• put / [[#RemoteAccessPut|RemoteAccessPut]]: Update the remote-access settings.

ResourcesApi#

• get / [[#ResourcesGet|ResourcesGet]]: Fetch the additionally provisioned resources

SoundApi#

• get / [[#SoundGet|SoundGet]]: Get the sound settings.
• put / [[#SoundPut|SoundPut]]: Update the sound settings.

TelephonyApi#

• get / [[#TelephonyGet|TelephonyGet]]: Get the telephony settings.
• put / [[#TelephonyPut|TelephonyPut]]: Update the telephony settings.

TemplatesApi#

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

TimeAndDateApi#

• get / [[#TimeAndDateGet|TimeAndDateGet]]: Get the timeAndDate settings.
• put / [[#TimeAndDatePut|TimeAndDatePut]]: Update the timeAndDate settings

UpdateApi#

• get / [[#UpdateGet|UpdateGet]]: Get the update settings.
• put / [[#UpdatePut|UpdatePut]]: Update the update settings.

UserInterfaceApi#

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

UsersApi#

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

VPNApi#

• get / [[#NetworkVpnGet|NetworkVpnGet]]: Get the vpn settings.

Endpoint List#

AboutPhoneGet#

''get /aboutPhone''

Description#

Get the aboutPhone settings.

Responses#

Response Schema

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

Response Schema

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

AboutPhonePut#

''put /aboutPhone''

Description#

Update the aboutPhone settings.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

AboutPhoneGet#

''get /aboutPhone''

Description#

Get the aboutPhone settings.

Responses#

Response Schema

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

Response Schema

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

AboutPhonePut#

''put /aboutPhone''

Description#

Update the aboutPhone settings.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

AppsGet#

''get /apps''

Description#

Get the apps-settings.

Responses#

Response Schema

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

Response Schema

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

AppsPut#

''put /apps''

Description#

Update the apps-settings.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

ContactListGet#

''get /contactList''

Description#

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

Responses#

Response Schema

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

ContactsDelete#

''delete /contacts''

Description#

Delete a contacts setup

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

ContactsGet#

''get /contacts''

Description#

Get a contacts setup

Responses#

Response Schema

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

Response Schema

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

ContactsPost#

''post /contacts''

Description#

Create a contacts setup

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

ContactsPut#

''put /contacts''

Description#

Update a contacts settings

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

DevicesCamerasGet#

''get /devices/cameras''

Description#

Get the Cameras settings.

Responses#

Response Schema

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

Response Schema

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

DevicesCamerasNameDelete#

''delete /devices/cameras/{name}''

Description#

Delete a camera by name

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNameGet#

''get /devices/cameras/{name}''

Description#

Get the camera with the specified name.

Path Parameters#

Responses#

Response Schema

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

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

DevicesCamerasNamePost#

''post /devices/cameras/{name}''

Description#

Create a Camera setup

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

DevicesCamerasNamePut#

''put /devices/cameras/{name}''

Description#

Update the camera with the specified name.

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

DevicesGet#

''get /devices''

Description#

Get the Devices settings.

Responses#

Response Schema

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

Response Schema

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

DevicesPost#

''post /devices''

Description#

Create a Devices setup

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

DevicesPut#

''put /devices''

Description#

Update a Devices setup.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

HomeScreenDesignGet#

''get /homeScreenDesign''

Description#

Get the home screen design

Responses#

Response Schema

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

HomeScreenDesignPut#

''put /homeScreenDesign''

Description#

Update the home screen design

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

IdentitiesGet#

''get /identities''

Description#

Get the list of identities

Responses#

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#

Responses#

Response Schema

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

Response Schema

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

IdentitiesIdxPut#

''put /identities/{idx}''

Description#

Update the identity at the specified index.

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

KeyLayerGet#

''get /keyLayer''

Description#

Get the keylayer settings

Responses#

Response Schema

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

Response Schema

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

KeyLayerPut#

''put /keyLayer''

Description#

Set the keylayer settings

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

KeysGet#

''get /keys''

Description#

Get all configured keys

Responses#

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#

Responses#

Response Schema

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

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberDelete#

''delete /keys/{group}/{keyNumber}''

Description#

Delete the key on the specified position in the group

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberGet#

''get /keys/{group}/{keyNumber}''

Description#

Get the key on the specified position

Path Parameters#

Responses#

Response Schema

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

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPost#

''post /keys/{group}/{keyNumber}''

Description#

Create a new key on the specified position

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

KeysGroupKeyNumberPut#

''put /keys/{group}/{keyNumber}''

Description#

Update the key on the specified position in the group

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

LocalesGet#

''get /locales''

Description#

Get the locale settings.

Responses#

Response Schema

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

Response Schema

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

LocalesPut#

''put /locales''

Description#

Update the locale settings.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

LoggingGet#

''get /logging''

Description#

Get the logging settings.

Responses#

Response Schema

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

Response Schema

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

LoggingPut#

''put /logging''

Description#

Set the logging settings.

Body Parameter#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

LuaAutoStartersGet#

''get /luaAutoStarters''

Description#

Get the luaAutoStarters settings.

Responses#

Response Schema

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

Response Schema

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

LuaAutoStartersNameGet#

''get /luaAutoStarters/{name}''

Description#

Get the luaScript with the specified name.

Path Parameters#

Responses#

Response Schema

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

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

LuaAutoStartersNamePut#

''put /luaAutoStarters/{name}''

Description#

Update the luaScript with the specified name.

Path Parameters#

Responses#

Response Schema

{
  "description" : "Operation successful"
}

Response Schema

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

Response Schema

{
  "description" : "Unauthorized"
}

Response Schema

{
  "description" : "Forbidden"
}

Response Schema

{
  "description" : "NotFound"
}

LuaConfigGet#

''get /luaConfig''

Description#

Get the luaConfig settings.

Responses#

Response Schema

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

Response Schema

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

LuaConfigKeyGet#

''get /luaConfig/{key}''

Description#

Get the luaScript with the specified name.

Path Parameters#

Responses#

Response Schema

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