res_ari

Since 12.0.0 Module Configuration Found this useful? Upvote it. ×

HTTP binding for the Stasis API

Last reviewed 2026-04-14

Description

ari.conf

[general]

General configuration settings

  • enabled - Enable/disable the ARI module

    Note

    ARI uses Asterisk's HTTP server, which must also be enabled in http.conf.

  • websocket_write_timeout - The timeout (in milliseconds) to set on WebSocket connections.

  • pretty - Responses from ARI are formatted to be human readable
  • auth_realm - Realm to use for authentication. Defaults to Asterisk REST Interface.
  • allowed_origins - Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins.
  • channelvars - Comma separated list of channel variables to display in channel json.
[user]

Per-user configuration settings

  • type - Define this configuration section as a user.
  • read_only - When set to yes, user is only authorized for read-only requests
  • password - Crypted or plaintext password (see password_format)
  • password_format - password_format may be set to plain (the default) or crypt. When set to crypt, crypt(3) is used to validate the password. A crypted password can be generated using mkpasswd -m sha-512. When set to plain, the password is in plaintext
  • acl - List of IP ACL section names in acl.conf
  • deny - List of IP addresses to deny access from
  • permit - List of IP addresses to permit access from
[outbound_websocket]

Outbound websocket configuration

  • type - Must be "outbound_websocket".
  • websocket_client_id - The ID of a connection defined in websocket_client.conf.
  • apps - Comma separated list of stasis applications that will use this websocket.
  • local_ari_user - The local ARI user to act as.
  • subscribe_all - Subscribe applications to all event

User Notes

No notes yet. Be the first to contribute a tip or example.

Contribute a note

Share a tip, gotcha, or practical example. Keep it under 2000 characters. No questions (use the Asterisk community forums for support). Wrap code in backticks.

Moderated before publishing. Email never shown.