openapi: 3.2.0
info:
  title: wazo-confd Custom API
  description: "Confd exposes an API for managing core resources on a Wazo server such as users, extensions, devices, voicemails, queues, etc. Resources can be associated together to provide additional functionality. For example: By associating a voicemail with a user, calls will automatically fallback on to the voicemail when the user cannot answer.\n\nImplementation notes\n====================\n\nErrors\n------\n\nResponses containing errors will have a status code in the 400 or 500 class. A list of error messages will be returned in the body of the response as a JSON-encoded array:\n\n~~~\n[\n    \"Input error - User not found\",\n    \"Resource error - User not associated to a line\"\n]\n~~~\n\n\nUpdating resources via PUT\n--------------------------\n\nWhen updating a resource, all fields become optional. In other words, only values that have been changed need to be sent to the server. Please note that this behavior may change in future versions of the API."
  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: custom
paths:
  /endpoints/custom:
    get:
      operationId: list_endpoints_custom
      summary: List Custom endpoints
      description: '**Required ACL:** `confd.endpoints.custom.read`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/recurse'
      - $ref: '#/components/parameters/order'
      - $ref: '#/components/parameters/direction'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/search'
      responses:
        '200':
          description: Custom endpoint list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointCustomItems'
    post:
      operationId: create_endpoint_custom
      summary: Create Custom endpoint
      description: '**Required ACL:** `confd.endpoints.custom.create`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '201':
          description: Custom endpoint created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointCustom'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointCustom'
        description: Custom Endpoint to create
        required: true
  /endpoints/custom/{custom_id}:
    get:
      operationId: get_endpoint_custom
      summary: Get Custom Endpoint
      description: '**Required ACL:** `confd.endpoints.custom.{custom_id}.read`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/customid'
      responses:
        '200':
          description: Custom Endpoint
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointCustom'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_endpoint_custom
      summary: Update Custom Endpoint
      description: '**Required ACL:** `confd.endpoints.custom.{custom_id}.update`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointCustom'
        required: true
    delete:
      operationId: delete_endpoint_custom
      summary: Delete Custom Endpoint
      description: '**Required ACL:** `confd.endpoints.custom.{custom_id}.delete`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /lines/{line_id}/endpoints/custom/{custom_id}:
    put:
      operationId: associate_line_endpoint_custom
      summary: Associate line and Custom endpoint
      description: '**Required ACL:** `confd.lines.{line_id}.endpoints.custom.{custom_id}.update`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/lineid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          description: Line and Custom endpoint associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_line_endpoint_custom
      summary: Dissociate line and Custom endpoint
      description: '**Required ACL:** `confd.lines.{line_id}.endpoints.custom.{custom_id}.delete`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/lineid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          description: Line and Custom endpoint dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
  /trunks/{trunk_id}/endpoints/custom/{custom_id}:
    put:
      operationId: associate_trunk_endpoint_custom
      summary: Associate trunk and Custom endpoint
      description: '**Required ACL:** `confd.trunks.{trunk_id}.endpoints.custom.{custom_id}.update`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          description: Trunk and Custom endpoint associated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
    delete:
      operationId: dissociate_trunk_endpoint_custom
      summary: Dissociate trunk and Custom endpoint
      description: '**Required ACL:** `confd.trunks.{trunk_id}.endpoints.custom.{custom_id}.delete`'
      tags:
      - custom
      parameters:
      - $ref: '#/components/parameters/trunkid'
      - $ref: '#/components/parameters/customid'
      responses:
        '204':
          description: Trunk and Custom endpoint dissociated
        '400':
          $ref: '#/components/responses/GenericError'
        '404':
          $ref: '#/components/responses/NotFoundError'
components:
  responses:
    NotFoundError:
      description: The resource requested was not found on the server
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ResourceDeleted:
      description: Resource was deleted successfully
    CreateError:
      description: An error occurred when creating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    GenericError:
      description: An error occurred during the operation
      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'
    DeleteError:
      description: An error occurred when deleting the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    EndpointRelationLine:
      properties:
        line:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/LineRelationBase'
    EndpointCustomItems:
      title: Custom Endpoints
      properties:
        items:
          items:
            $ref: '#/components/schemas/EndpointCustom'
          type: array
        total:
          type: integer
    EndpointCustomRelationBase:
      properties:
        id:
          type: integer
          description: Custom Endpoint ID
          readOnly: true
        interface:
          type: string
          description: Asterisk interface to use. (e.g. 'dahdi/i1')
    TrunkRelationBase:
      properties:
        id:
          type: integer
          readOnly: true
          description: The id of the trunk
        tenant_uuid:
          type: string
          description: The UUID of the tenant
          readOnly: true
    EndpointCustom:
      title: Custom Endpoint
      allOf:
      - $ref: '#/components/schemas/EndpointCustomRelationBase'
      - properties:
          tenant_uuid:
            type: string
            description: The UUID of the tenant
            readOnly: true
          enabled:
            type: boolean
            description: Endpoint can be used when it is enabled
            default: true
      - $ref: '#/components/schemas/EndpointRelationTrunk'
      - $ref: '#/components/schemas/EndpointRelationLine'
      - required:
        - interface
    Error:
      type: array
      items:
        type: string
    EndpointRelationTrunk:
      properties:
        trunk:
          $ref: '#/components/schemas/TrunkRelationBase'
          readOnly: true
    LineRelationBase:
      properties:
        id:
          type: integer
          description: Line ID
          readOnly: true
        name:
          type: string
          description: The name of the line
          readOnly: true
  parameters:
    lineid:
      required: true
      name: line_id
      in: path
      schema:
        type: integer
    tenantuuid:
      name: Wazo-Tenant
      in: header
      description: The tenant's UUID, defining the ownership of a given resource.
      required: false
      schema:
        type: string
    customid:
      required: true
      name: custom_id
      in: path
      schema:
        type: integer
    offset:
      required: false
      name: offset
      in: query
      description: Number of items to skip over in the list. Useful for pagination.
      schema:
        type: integer
    order:
      required: false
      name: order
      in: query
      description: Name of the field to use for sorting the list of items returned.
      schema:
        type: string
    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
    recurse:
      name: recurse
      in: query
      description: Should the query include sub-tenants
      required: false
      schema:
        type: boolean
        default: false
    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
    trunkid:
      description: Trunk's ID
      name: trunk_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
  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'