> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pgw.sipmicro.services/llms.txt
> Use this file to discover all available pages before exploring further.

# Change an upstream

> Changes the fields in the body and keeps the others. The host can't
change: delete the upstream and create it again. pgw applies a new
`invite_source_cidrs` and new `domains` at once. pgw returns `400`
for a `transport` other than `udp` or `tcp`, and for an empty
`invite_source_cidrs` on an upstream whose host is a DNS name. It
returns `409` when another upstream has one of the new `domains`,
and when the new `domains` would leave a user of the upstream at a
domain that they don't serve. Delete those users first.




## OpenAPI

````yaml /reference/openapi.yaml patch /upstreams/{id}
openapi: 3.1.0
info:
  title: pgw admin API
  version: 0.4.0
  description: |
    Manage a pgw tenant: its apps, upstreams, managed mode users, bindings,
    and push log.

    The API listens on `admin_listen`, `127.0.0.1:8080` by default, over plain
    HTTP. Every endpoint except `POST /bootstrap`, `POST /tls/reload`, and the
    register bans needs a tenant API key in the `Authorization` header. Those
    need the server's `PGW_BOOTSTRAP_TOKEN`. Request bodies are JSON objects
    of at most 1 MiB, or 16 MiB for `POST /config/sync`, and pgw rejects
    unknown fields. Responses are never cached.

    An unknown path gets `404`, and a method that the path doesn't serve gets
    `405` with an `Allow` header. Every `GET` endpoint also answers `HEAD`.
    An endpoint that needs an API key answers `500` when pgw can't check the
    key.

    The same listener also serves `GET /metrics`, `GET /healthz`, and
    `GET /readyz`, outside `/api/v1` and without authentication. The health
    checks and metrics pages describe them.
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: '{baseUrl}'
    description: Your pgw admin listener
    variables:
      baseUrl:
        default: http://127.0.0.1:8080/api/v1
        description: The address of admin_listen, followed by /api/v1.
  - url: http://localhost:8080/api/v1
    description: pgw on this computer
security:
  - apiKey: []
tags:
  - name: Tenant
    description: Create the first tenant and read the caller's tenant.
  - name: Apps
    description: Mobile and web apps and their push credentials.
  - name: Upstreams
    description: PBXs that pgw registers apps with.
  - name: Users
    description: >-
      SIP accounts that pgw checks itself and registers at the PBX in managed
      mode.
  - name: Bindings
    description: Devices registered through pgw.
  - name: Push events
    description: The log of push attempts.
  - name: TLS
    description: The certificate that pgw presents to apps.
  - name: Register bans
    description: >-
      Source addresses that pgw refuses REGISTERs from after too many refused
      credentials.
  - name: Config
    description: Export a tenant's configuration and make it match a snapshot.
paths:
  /upstreams/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The upstream ID.
        schema:
          type: string
    patch:
      tags:
        - Upstreams
      summary: Change an upstream
      description: |
        Changes the fields in the body and keeps the others. The host can't
        change: delete the upstream and create it again. pgw applies a new
        `invite_source_cidrs` and new `domains` at once. pgw returns `400`
        for a `transport` other than `udp` or `tcp`, and for an empty
        `invite_source_cidrs` on an upstream whose host is a DNS name. It
        returns `409` when another upstream has one of the new `domains`,
        and when the new `domains` would leave a user of the upstream at a
        domain that they don't serve. Delete those users first.
      operationId: updateUpstream
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchUpstreamRequest'
            example:
              invite_source_cidrs:
                - 203.0.113.10/32
                - 203.0.113.11/32
      responses:
        '200':
          description: The updated upstream.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Upstream'
              example:
                id: Ux9cT4mK7pLw2RvN5yQs8g
                name: asterisk
                host: pbx.example.com
                domains:
                  - '*.example.com'
                port: 5060
                transport: udp
                mode: passthrough
                contact_strategy: path
                max_expires: 3600
                invite_source_cidrs:
                  - 203.0.113.10/32
                  - 203.0.113.11/32
                strict_path: true
                keepalive_seconds: 30
                managed_registration: ''
                user_source: pgw
                app_auth: digest
                created_at: '2026-11-02T08:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/UpstreamNotFound'
        '409':
          description: |
            Another upstream, of any tenant, has one of the domains, or the
            domains don't serve one of the upstream's users.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                taken:
                  summary: A domain of another upstream
                  value:
                    error: >-
                      domains: acme.example.com is already served by another
                      upstream
                stranded:
                  summary: A user at a domain that the new list drops
                  value:
                    error: >-
                      every user of an upstream with domains needs a domain that
                      it serves
        '500':
          $ref: '#/components/responses/InternalError'
components:
  schemas:
    PatchUpstreamRequest:
      type: object
      additionalProperties: false
      properties:
        host:
          type: string
          description: Exists only to refuse a change. Any value gets 400.
        name:
          type: string
          minLength: 1
        domains:
          type: array
          items:
            type: string
          description: >-
            Replaces the list. An empty list removes every domain. Omit to keep
            the current list.
        port:
          type: integer
          minimum: 1
          maximum: 65535
        transport:
          type: string
          enum:
            - udp
            - tcp
        max_expires:
          type: integer
          minimum: 1
          maximum: 4294967295
        invite_source_cidrs:
          type: array
          items:
            type: string
          description: |
            Replaces the list. An empty list removes every prefix, which an
            upstream whose host is a DNS name can't have.
        strict_path:
          type: boolean
          description: |
            Refuse a registration when the PBX's answer doesn't keep pgw's
            Path. The PBX then never sends calls past pgw.
        keepalive_seconds:
          type: integer
          description: '`0` turns the OPTIONS keepalive off; otherwise from 5 to 3600.'
        contact_strategy:
          type: string
          description: >-
            Exists only to refuse a change. Any value other than the upstream's
            gets 400.
        mode:
          type: string
          description: >-
            Exists only to refuse a change. Any value other than the upstream's
            gets 400.
        realm:
          type: string
          description: >-
            Exists only to refuse a change. Any value other than the upstream's
            gets 400.
        managed_registration:
          type: string
          enum:
            - ''
            - per_user
            - per_device
          description: >-
            Changes how a managed upstream registers devices at the PBX. An
            empty string uses the gateway default. Omit to keep the current
            value.
        user_source:
          type: string
          description: >-
            Exists only to refuse a change. Any value other than the upstream's
            gets 400.
        kamailio:
          $ref: '#/components/schemas/KamailioRequest'
        app_auth:
          type: string
          enum:
            - digest
            - bearer
            - both
          description: >-
            Changing to `digest` drops `bearer`. Changing to `bearer` or `both`
            needs every `bearer` field, stored or sent.
        bearer:
          $ref: '#/components/schemas/BearerRequest'
    Upstream:
      type: object
      required:
        - id
        - name
        - host
        - port
        - transport
        - mode
        - contact_strategy
        - max_expires
        - invite_source_cidrs
        - strict_path
        - keepalive_seconds
        - managed_registration
        - user_source
        - app_auth
        - created_at
      properties:
        id:
          type: string
        name:
          type: string
        host:
          type: string
        domains:
          type: array
          items:
            type: string
          description: The upstream's domains, sorted. Absent when it has none.
        port:
          type: integer
        transport:
          type: string
          enum:
            - udp
            - tcp
            - tls
          description: |
            pgw doesn't connect to PBXs over `tls`, so registrations to such an
            upstream fail. Change it to `udp` or `tcp`; until then, any other
            change gets 400.
        mode:
          type: string
          enum:
            - passthrough
            - managed
        contact_strategy:
          type: string
          enum:
            - path
            - masquerade
        max_expires:
          type: integer
        invite_source_cidrs:
          type: array
          items:
            type: string
        strict_path:
          type: boolean
        keepalive_seconds:
          type: integer
        realm:
          type: string
          description: The digest realm of a managed upstream. Absent when it is the host.
        managed_registration:
          type: string
          enum:
            - ''
            - per_user
            - per_device
          description: Empty when the upstream uses the gateway default.
        user_source:
          type: string
          enum:
            - pgw
            - kamailio
        kamailio:
          $ref: '#/components/schemas/Kamailio'
        app_auth:
          type: string
          enum:
            - digest
            - bearer
            - both
        bearer:
          $ref: '#/components/schemas/Bearer'
        created_at:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong. Never contains the values that you sent.
    KamailioRequest:
      type: object
      additionalProperties: false
      description: |
        The Kamailio database of an upstream with `user_source` `kamailio`.
        pgw connects to it over TCP and reads its tables before it stores
        the upstream, and answers 400 with the step that failed. On create,
        `driver`, `host`, `user`, `password`, and `database` are required,
        and a table or column left out gets Kamailio's own name. On update,
        each field replaces the stored one. A table or column name is a
        letter or an underscore, then at most 63 letters, digits, or
        underscores.
      properties:
        driver:
          type: string
          enum:
            - mysql
            - postgres
          description: '`mysql` also reads MariaDB.'
        host:
          type: string
          description: The database's DNS name or IP address, without a port.
        port:
          type: integer
          minimum: 1
          maximum: 65535
          description: The default is 3306 for `mysql` and 5432 for `postgres`.
        user:
          type: string
          minLength: 1
          maxLength: 128
          description: >-
            The database user, which needs only `SELECT` on the subscriber and
            domain tables.
        password:
          type: string
          minLength: 1
          maxLength: 256
          writeOnly: true
          description: The database user's password. pgw encrypts it and never returns it.
        database:
          type: string
          minLength: 1
          maxLength: 64
        tls:
          type: string
          enum:
            - 'off'
            - require
            - verify
          default: verify
          description: |
            `verify`: TLS, with the server's certificate checked against the
            system's roots and `host`. `require`: TLS without that check, for
            a server with a self-signed certificate. `off`: plain TCP.
        use_domain:
          type: boolean
          default: true
          description: |
            Look subscribers up by username and domain, as Kamailio's
            `use_domain` does, and accept registrations to the domains in the
            domain table. When false, pgw looks subscribers up by username
            and doesn't read the domain table. It can't change later.
        subscriber_table:
          type: string
          default: subscriber
        username_column:
          type: string
          default: username
        domain_column:
          type: string
          default: domain
        password_column:
          type: string
          default: password
          description: >-
            Empty when the table keeps no plain passwords. It can't be empty
            when `ha1_column` is.
        ha1_column:
          type: string
          default: ha1
          description: >-
            Empty when the table keeps no `ha1` hashes. It can't be empty when
            `password_column` is.
        domain_table:
          type: string
          default: domain
        domain_table_column:
          type: string
          default: domain
    BearerRequest:
      type: object
      additionalProperties: false
      description: |
        The issuer of the access tokens that apps present, required with
        `app_auth` `bearer` or `both` and refused with `digest`. On create,
        every field is required. On update, each field present replaces the
        stored one.
      properties:
        issuer:
          type: string
          maxLength: 1024
          description: Compared byte for byte with the token's `iss` claim.
        audience:
          type: string
          maxLength: 1024
          description: Must be in the token's `aud` claim.
        jwks_url:
          type: string
          maxLength: 1024
          description: |
            The issuer's JSON Web Key Set. An `https` URL with a host and
            without user information. pgw fetches it when a token names a
            key that pgw doesn't have, at most once a minute, and every hour.
    Kamailio:
      type: object
      required:
        - driver
        - host
        - port
        - user
        - database
        - tls
        - password_set
        - use_domain
        - subscriber_table
        - username_column
        - domain_column
        - password_column
        - ha1_column
        - domain_table
        - domain_table_column
      properties:
        driver:
          type: string
          enum:
            - mysql
            - postgres
        host:
          type: string
        port:
          type: integer
        user:
          type: string
        database:
          type: string
        tls:
          type: string
          enum:
            - 'off'
            - require
            - verify
        password_set:
          type: boolean
          description: Whether pgw holds the database password. pgw never returns it.
        use_domain:
          type: boolean
        subscriber_table:
          type: string
        username_column:
          type: string
        domain_column:
          type: string
        password_column:
          type: string
        ha1_column:
          type: string
        domain_table:
          type: string
        domain_table_column:
          type: string
    Bearer:
      type: object
      required:
        - issuer
        - audience
        - jwks_url
      properties:
        issuer:
          type: string
        audience:
          type: string
        jwks_url:
          type: string
  responses:
    BadRequest:
      description: >-
        The request body or a parameter isn't valid. The message names the
        field.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            field:
              summary: A field that isn't valid
              value:
                error: 'invalid request: platform must be "ios", "android", or "web"'
            json:
              summary: A body that isn't valid JSON
              value:
                error: 'invalid JSON body: unknown field "colour"'
            limit:
              summary: A query parameter out of range
              value:
                error: limit must be from 1 to 1000
    Unauthorized:
      description: The API key is missing or unknown.
      headers:
        WWW-Authenticate:
          schema:
            type: string
            const: Bearer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: missing or unknown API key
    UpstreamNotFound:
      description: The tenant has no upstream with this ID.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: no such upstream
    InternalError:
      description: pgw failed to complete the request. The details are in pgw's log.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: internal error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: The tenant API key that `POST /bootstrap` returned.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.