openapi: 3.2.0
info:
  title: wazo-confd Ingresses 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: ingresses
paths:
  /ingresses/http:
    get:
      operationId: list_http_ingresses
      summary: List HTTP ingresses
      description: '**Required ACL:** `confd.ingresses.http.read`'
      tags:
      - ingresses
      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'
      - $ref: '#/components/parameters/ingress_fallback_view'
      responses:
        '200':
          description: HTTP ingress list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPIngressItems'
    post:
      operationId: create_http_ingress
      summary: Create HTTP Ingress
      description: '**Required ACL:** `confd.ingresses.http.create`'
      tags:
      - ingresses
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      responses:
        '201':
          description: HTTP ingress ceated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPIngress'
        '400':
          $ref: '#/components/responses/CreateError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HTTPIngressRequest'
        description: HTTP Ingress to create
        required: true
  /ingresses/http/{http_ingress_uuid}:
    get:
      operationId: get_http_ingress
      summary: Get HTTP ingress
      description: '**Required ACL:** `confd.ingresses.http.{http_ingress_uuid}.read`'
      tags:
      - ingresses
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/http_ingress_uuid'
      responses:
        '200':
          description: HTTP ingress
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPIngress'
        '404':
          $ref: '#/components/responses/NotFoundError'
    put:
      operationId: update_http_ingress
      summary: Update HTTP ingress
      description: '**Required ACL:** `confd.ingresses.http.{http_ingress_uuid}.update`'
      tags:
      - ingresses
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/http_ingress_uuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceUpdated'
        '400':
          $ref: '#/components/responses/UpdateError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HTTPIngressRequest'
        required: true
    delete:
      operationId: delete_http_ingress
      summary: Delete HTTP ingress
      description: '**Required ACL:** `confd.ingresses.http.{http_ingress_uuid}.delete`'
      tags:
      - ingresses
      parameters:
      - $ref: '#/components/parameters/tenantuuid'
      - $ref: '#/components/parameters/http_ingress_uuid'
      responses:
        '204':
          $ref: '#/components/responses/ResourceDeleted'
        '400':
          $ref: '#/components/responses/DeleteError'
        '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
    ResourceUpdated:
      description: Resource was updated successfully
    CreateError:
      description: An error occurred when creating the resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    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'
  parameters:
    tenantuuid:
      name: Wazo-Tenant
      in: header
      description: The tenant's UUID, defining the ownership of a given resource.
      required: false
      schema:
        type: string
    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
    ingress_fallback_view:
      description: 'Allows to fallback on master tenant config if the current tenant has no ingress set.

        When the `view` is omitted or the `default`value is passed, only the ingress of the current tenant is returned. This is useful for configuration API.

        For `fallback` view the API fallbacks to the master tenant ingress value. '
      in: query
      name: view
      required: false
      schema:
        type: string
        enum:
        - default
        - fallback
    limit:
      required: false
      name: limit
      in: query
      description: Maximum number of items to return in the list
      schema:
        type: integer
    http_ingress_uuid:
      required: true
      name: http_ingress_uuid
      in: path
      schema:
        type: string
  schemas:
    HTTPIngressItems:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/HTTPIngress'
    HTTPIngressRequest:
      type: object
      properties:
        uri:
          type: string
          description: The public URI to contact this stack HTTP API
      required:
      - uri
    HTTPIngress:
      type: object
      allOf:
      - $ref: '#/components/schemas/HTTPIngressRequest'
      - properties:
          uuid:
            type: string
            readOnly: true
    Error:
      type: array
      items:
        type: string
  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'