Wazo Registers API

The registers API from Wazo — 3 operation(s) for registers.

Operations 7

GET /registers/iax List registers iax #
POST /registers/iax Create register_iax #
GET /registers/iax/{register_iax_id} Get register IAX #
PUT /registers/iax/{register_iax_id} Update register IAX #
DELETE /registers/iax/{register_iax_id} Delete register IAX #
PUT /trunks/{trunk_id}/registers/iax/{iax_id} Associate trunk and IAX register #
DELETE /trunks/{trunk_id}/registers/iax/{iax_id} Dissociate trunk and IAX register #

Documentation

Specifications

Other Resources

🔗
Console
https://api.wazo.io/documentation/console/authentication/
🔗
SourceCode
https://github.com/wazo-platform/wazo-auth
🔗
ChangeLog
https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/conventions/wazo-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/errors/wazo-problem-types.yml
🔗
Console
https://api.wazo.io/documentation/console/configuration/
🔗
SourceCode
https://github.com/wazo-platform/wazo-confd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-confd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/application/
🔗
SourceCode
https://github.com/wazo-platform/wazo-calld
🔗
ChangeLog
https://github.com/wazo-platform/wazo-calld/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/cdr/
🔗
SourceCode
https://github.com/wazo-platform/wazo-call-logd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-call-logd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/contact/
🔗
SourceCode
https://github.com/wazo-platform/wazo-dird
🔗
ChangeLog
https://github.com/wazo-platform/wazo-dird/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/webhook/
🔗
SourceCode
https://github.com/wazo-platform/wazo-webhookd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-webhookd/blob/master/CHANGELOG.md
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/wazo/refs/heads/main/asyncapi/wazo-events-webhooks.yml
🔗
Console
https://api.wazo.io/documentation/console/plugins/
🔗
SourceCode
https://github.com/wazo-platform/wazo-plugind
🔗
ChangeLog
https://github.com/wazo-platform/wazo-plugind/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/agent/
🔗
SourceCode
https://github.com/wazo-platform/wazo-agentd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-agentd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/chat/
🔗
SourceCode
https://github.com/wazo-platform/wazo-chatd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-chatd/blob/master/CHANGELOG.md
🔗
SourceCode
https://github.com/wazo-platform/wazo-phoned
🔗
ChangeLog
https://github.com/wazo-platform/wazo-phoned/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/setup/
🔗
SourceCode
https://github.com/wazo-platform/wazo-setupd
🔗
ChangeLog
https://github.com/wazo-platform/wazo-setupd/blob/master/CHANGELOG.md
🔗
Console
https://api.wazo.io/documentation/console/amid/
🔗
SourceCode
https://github.com/wazo-platform/wazo-amid
🔗
ChangeLog
https://github.com/wazo-platform/wazo-amid/blob/master/CHANGELOG.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/wazo-registers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

wazo-registers-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: wazo-confd Registers API
  description: Confd exposes an API for managing core resources on a Wazo server such as users, extensions, devices, voicemails, queues, etc.
  version: '1.1'
  license:
    name: GPL v3
    url: http://www.gnu.org/licenses/gpl.txt
  contact:
    name: Wazo Dev Team
    url: https://wazo-platform.org/
    email: dev@wazo.community
  x-logo:
    url: https://wazo-platform.org/images/logo-black.svg
    backgroundColor: '#FAFAFA'
    altText: Wazo Logo
servers:
- url: /1.1
security:
- wazo_auth_token: []
tags:
- name: Registers
paths:
  /registers/iax:
    get:
      operationId: list_registers_iax
      summary: List registers iax
      description: '**Required ACL:** `confd.registers.iax.read`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Registers IAX list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAXItems'
    post:
      operationId: create_register_iax
      summary: Create register_iax
      description: '**Required ACL:** `confd.registers.iax.create`'
      tags:
      - Registers
      responses:
        '201':
          description: Register IAX created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAX'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterIAX'
        description: Register iax to create
        required: true
  /registers/iax/{register_iax_id}:
    get:
      operationId: get_register_iax
      summary: Get register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.read`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '200':
          description: Register IAX
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegisterIAX'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_register_iax
      summary: Update register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.update`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegisterIAX'
        required: true
    delete:
      operationId: delete_register_iax
      summary: Delete register IAX
      description: '**Required ACL:** `confd.registers.iax.{register_iax_id}.delete`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/registeriaxid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /trunks/{trunk_id}/registers/iax/{iax_id}:
    put:
      operationId: associate_trunk_register_iax
      summary: Associate trunk and IAX register
      description: '**Required ACL:** `confd.trunks.{trunk_id}.registers.iax.{iax_id}.update`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/iaxid'
      responses:
        '204':
          description: Trunk and IAX register associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_trunk_register_iax
      summary: Dissociate trunk and IAX register
      description: '**Required ACL:** `confd.trunks.{trunk_id}.registers.iax.{iax_id}.delete`'
      tags:
      - Registers
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/iaxid'
      responses:
        '204':
          description: Trunk and IAX register dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  responses:
    GenericError:
      description: An error occurred during the operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFoundError:
      description: The resource requested was not found on the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    DeleteError:
      description: An error occurred when deleting the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ResourceUpdated:
      description: Resource was updated successfully
    UpdateError:
      description: An error occurred when updating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    CreateError:
      description: An error occurred when creating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ResourceDeleted:
      description: Resource was deleted successfully
  parameters:
    offset:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    trunkid:
      description: Trunk's ID
      name: trunk_id
      in: path
      required: true
      schema:
        type: integer
    direction:
      required: false
      name: direction
      in: query
      description: Sort list of items in 'asc' (ascending) or 'desc' (descending) order
      schema:
        type: string
        enum:
        - asc
        - desc
    order:
      required: false
      name: order
      in: query
      description: Name of the field to use for sorting the list of items returned.
      schema:
        type: string
    iaxid:
      required: true
      name: iax_id
      in: path
      schema:
        type: integer
    registeriaxid:
      description: Register IAX's ID
      name: register_iax_id
      in: path
      required: true
      schema:
        type: integer
    limit:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list
      schema:
        type: integer
    search:
      required: false
      name: search
      in: query
      description: Search term for filtering a list of items. Only items with a field containing the search term will be returned.
      schema:
        type: string
  schemas:
    RegisterIAXItems:
      title: RegisterItems
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/RegisterIAX'
        total:
          type: integer
    Error:
      type: array
      items:
        type: string
    RegisterIAXRelationBase:
      properties:
        id:
          type: integer
          readOnly: true
          description: The id of the register IAX
    RegisterIAX:
      title: Register IAX
      allOf:
      - $ref: '#/components/schemas/RegisterIAXRelationBase'
      - properties:
          auth_username:
            type: string
            description: The username used by the remote_host for the authentication
          auth_password:
            type: string
            description: The password to authenticate to the remote_host
          remote_host:
            type: string
            description: The register domain
          remote_port:
            type: integer
            description: The port of the remote_host
          callback_extension:
            type: string
            description: The callback extension to use for the register
          callback_context:
            type: string
            description: The callback context to use for the register
        required:
        - remote_host
  securitySchemes:
    wazo_auth_token:
      type: apiKey
      name: X-Auth-Token
      in: header
x-xivo-port: 9486
x-xivo-name: confd
x-apievangelist-source:
  harvested_from: https://github.com/wazo-platform/wazo-confd
  assembly: base plugin api.yml deep-merged with all plugin api.yml fragments, reproducing what the running service serves at /api/confd/1.1/api/api.yml (see wazo_confd/plugins/api/http.py — xivo.chain_map.ChainMap)
  spec_version: Swagger 2.0 (as published by Wazo)
  harvested: '2026-08-17'