Skip to end of metadata
Go to start of metadata

Asterisk

Method

Path<br>h5. Parameters are case-sensitive

Return Model

Summary

GET

/asterisk/config/dynamic/{configClass}/{objectType}/{id}

List[ConfigTuple]

Retrieve a dynamic configuration object.

PUT

/asterisk/config/dynamic/{configClass}/{objectType}/{id}

List[ConfigTuple]

Create or update a dynamic configuration object.

DELETE

/asterisk/config/dynamic/{configClass}/{objectType}/{id}

void

Delete a dynamic configuration object.

GET

/asterisk/info

AsteriskInfo

Gets Asterisk system information.

GET

/asterisk/modules

List[Module]

List Asterisk modules.

GET

/asterisk/modules/{moduleName}

Module

Get Asterisk module information.

POST

/asterisk/modules/{moduleName}

void

Load an Asterisk module.

DELETE

/asterisk/modules/{moduleName}

void

Unload an Asterisk module.

PUT

/asterisk/modules/{moduleName}

void

Reload an Asterisk module.

GET

/asterisk/logging

List[LogChannel]

Gets Asterisk log channel information.

POST

/asterisk/logging/{logChannelName}

void

Adds a log channel.

DELETE

/asterisk/logging/{logChannelName}

void

Deletes a log channel.

PUT

/asterisk/logging/{logChannelName}/rotate

void

Rotates a log channel.

GET

/asterisk/variable

Variable

Get the value of a global variable.

POST

/asterisk/variable

void

Set the value of a global variable.

getObject: GET /asterisk/config/dynamic/{configClass}/{objectType}/{id}

Retrieve a dynamic configuration object.

Path parameters

Parameters are case-sensitive.

  • configClass: string - The configuration class containing dynamic configuration objects.
  • objectType: string - The type of configuration object to retrieve.
  • id: string - The unique identifier of the object to retrieve.

Error Responses

  • 404 - {configClass|objectType|id} not found

updateObject: PUT /asterisk/config/dynamic/{configClass}/{objectType}/{id}

Create or update a dynamic configuration object.

Path parameters

Parameters are case-sensitive.

  • configClass: string - The configuration class containing dynamic configuration objects.
  • objectType: string - The type of configuration object to create or update.
  • id: string - The unique identifier of the object to create or update.

Body parameter

  • fields: containers - The body object should have a value that is a list of ConfigTuples, which provide the fields to update. Ex. [ { "attribute": "directmedia", "value": "false" } ]

Error Responses

  • 400 - Bad request body
  • 403 - Could not create or update object
  • 404 - {configClass|objectType} not found

deleteObject: DELETE /asterisk/config/dynamic/{configClass}/{objectType}/{id}

Delete a dynamic configuration object.

Path parameters

Parameters are case-sensitive.

  • configClass: string - The configuration class containing dynamic configuration objects.
  • objectType: string - The type of configuration object to delete.
  • id: string - The unique identifier of the object to delete.

Error Responses

  • 403 - Could not delete object
  • 404 - {configClass|objectType|id} not found

getInfo: GET /asterisk/info

Gets Asterisk system information.

Query parameters

  • only: string - Filter information returned
    • Allowed values: build, system, config, status
    • Allows comma separated values.

listModules: GET /asterisk/modules

List Asterisk modules.

getModule: GET /asterisk/modules/{moduleName}

Get Asterisk module information.

Path parameters

Parameters are case-sensitive.

  • moduleName: string - Module's name

Error Responses

  • 404 - Module could not be found in running modules.
  • 409 - Module information could not be retrieved.

loadModule: POST /asterisk/modules/{moduleName}

Load an Asterisk module.

Path parameters

Parameters are case-sensitive.

  • moduleName: string - Module's name

Error Responses

  • 409 - Module could not be loaded.

unloadModule: DELETE /asterisk/modules/{moduleName}

Unload an Asterisk module.

Path parameters

Parameters are case-sensitive.

  • moduleName: string - Module's name

Error Responses

  • 404 - Module not found in running modules.
  • 409 - Module could not be unloaded.

reloadModule: PUT /asterisk/modules/{moduleName}

Reload an Asterisk module.

Path parameters

Parameters are case-sensitive.

  • moduleName: string - Module's name

Error Responses

  • 404 - Module not found in running modules.
  • 409 - Module could not be reloaded.

listLogChannels: GET /asterisk/logging

Gets Asterisk log channel information.

addLog: POST /asterisk/logging/{logChannelName}

Adds a log channel.

Path parameters

Parameters are case-sensitive.

  • logChannelName: string - The log channel to add

Query parameters

  • configuration: string - (required) levels of the log channel

Error Responses

  • 400 - Bad request body
  • 409 - Log channel could not be created.

deleteLog: DELETE /asterisk/logging/{logChannelName}

Deletes a log channel.

Path parameters

Parameters are case-sensitive.

  • logChannelName: string - Log channels name

Error Responses

  • 404 - Log channel does not exist.

rotateLog: PUT /asterisk/logging/{logChannelName}/rotate

Rotates a log channel.

Path parameters

Parameters are case-sensitive.

  • logChannelName: string - Log channel's name

Error Responses

  • 404 - Log channel does not exist.

getGlobalVar: GET /asterisk/variable

Get the value of a global variable.

Query parameters

  • variable: string - (required) The variable to get

Error Responses

  • 400 - Missing variable parameter.

setGlobalVar: POST /asterisk/variable

Set the value of a global variable.

Query parameters

  • variable: string - (required) The variable to set
  • value: string - The value to set the variable to

Error Responses

  • 400 - Missing variable parameter.
  • No labels