{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cisco Expressway Configuration API",
    "version": "14.2.0"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "System",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway Retrieve system information",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/sysinfo"
          },
          "docs": "Returns basic system information for the Expressway node including the system name, software version, hardware details, serial number, and uptime."
        }
      ]
    },
    {
      "info": {
        "name": "DNS",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway List all configured DNS servers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/v1/provisioning/common/dns/dnsserver"
          },
          "docs": "Retrieves the list of all DNS servers configured on the Expressway. Supports filtering by name or address using query path segments such as /dnsserver/address/{address}."
        },
        {
          "info": {
            "name": "Cisco Expressway Add a new DNS server",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/v1/provisioning/common/dns/dnsserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a new DNS server entry to the Expressway configuration. The Expressway supports up to five DNS server addresses."
        },
        {
          "info": {
            "name": "Cisco Expressway Modify a DNS server entry",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/v1/provisioning/common/dns/dnsserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing DNS server configuration on the Expressway. The target server is identified by its current address or index."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a DNS server entry",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/v1/provisioning/common/dns/dnsserver"
          },
          "docs": "Removes a DNS server from the Expressway configuration. The target server is identified by its address or index in the configuration."
        }
      ]
    },
    {
      "info": {
        "name": "NTP",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway List all configured NTP servers",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/v1/provisioning/common/time/ntpserver"
          },
          "docs": "Retrieves the list of all NTP servers configured on the Expressway for time synchronization. Supports filtering by name or address."
        },
        {
          "info": {
            "name": "Cisco Expressway Add a new NTP server",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/v1/provisioning/common/time/ntpserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Adds a new NTP server entry to the Expressway configuration for time synchronization. Up to five NTP servers can be configured."
        },
        {
          "info": {
            "name": "Cisco Expressway Modify an NTP server entry",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/v1/provisioning/common/time/ntpserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates an existing NTP server configuration on the Expressway."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete an NTP server entry",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/v1/provisioning/common/time/ntpserver"
          },
          "docs": "Removes an NTP server from the Expressway configuration."
        }
      ]
    },
    {
      "info": {
        "name": "SFTP",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway Retrieve SFTP configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/v1/provisioning/common/sftpconfig"
          },
          "docs": "Returns the current SFTP configuration used for system upgrades including the SFTP server address, port, path, and credentials."
        },
        {
          "info": {
            "name": "Cisco Expressway Update SFTP configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/v1/provisioning/common/sftpconfig",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Updates the SFTP configuration for system upgrades. Configure the server address, credentials, and file path to the upgrade image."
        }
      ]
    },
    {
      "info": {
        "name": "Upgrade",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway Trigger a system upgrade",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/v1/provisioning/common/upgrade",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Initiates a system software upgrade on the Expressway. The SFTP configuration must be set before triggering the upgrade. The upgrade process downloads the image via SFTP and optionally reboots the system automatically."
        }
      ]
    },
    {
      "info": {
        "name": "Admin Account",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway Change administrator password",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/v1/provisioning/common/adminaccount/changepassword",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Changes the password for an administrator account on the Expressway. Requires the current password and the new password."
        }
      ]
    },
    {
      "info": {
        "name": "Zones",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway List Expressway-E traversal server zones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/edge/zone/traversalserver"
          },
          "docs": "Retrieves all traversal server zones configured on the Expressway-E. Traversal server zones enable the Expressway-E to provide firewall traversal services to traversal clients (Expressway-C). Supports filtering by name using the path pattern /zone/traversalserver/name/{zoneName}."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a traversal server zone on Expressway-E",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/edge/zone/traversalserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new traversal server zone on the Expressway-E to provide firewall traversal services. The zone defines connection credentials, H.323 and SIP protocol settings, and media encryption mode."
        },
        {
          "info": {
            "name": "Cisco Expressway Update a traversal server zone on Expressway-E",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/edge/zone/traversalserver",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies an existing traversal server zone configuration on the Expressway-E including connection credentials, protocol settings, and media encryption parameters."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a traversal server zone from Expressway-E",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/provisioning/edge/zone/traversalserver"
          },
          "docs": "Removes a traversal server zone from the Expressway-E configuration. The zone is identified by its name."
        },
        {
          "info": {
            "name": "Cisco Expressway List Expressway-C traversal client zones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/controller/zone/traversalclient"
          },
          "docs": "Retrieves all traversal client zones configured on the Expressway-C. Traversal client zones define connections from the Expressway-C to a traversal server (Expressway-E) across a firewall. Supports filtering by name using the path pattern /zone/traversalclient/name/{zoneName}."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a traversal client zone on Expressway-C",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/controller/zone/traversalclient",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new traversal client zone on the Expressway-C to connect to a traversal server (Expressway-E) across a firewall. The zone defines connection credentials, retry intervals, and protocol settings."
        },
        {
          "info": {
            "name": "Cisco Expressway Update a traversal client zone on Expressway-C",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/controller/zone/traversalclient",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies an existing traversal client zone configuration on the Expressway-C including connection credentials, retry intervals, and protocol settings."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a traversal client zone from Expressway-C",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/provisioning/controller/zone/traversalclient"
          },
          "docs": "Removes a traversal client zone from the Expressway-C configuration."
        },
        {
          "info": {
            "name": "Cisco Expressway List all neighbor zones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/zone/neighbor"
          },
          "docs": "Retrieves all neighbor zones configured on the Expressway. Neighbor zones connect the local Expressway to another system such as another Expressway, Unified CM, or a gatekeeper. Supports filtering by name."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a neighbor zone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/common/zone/neighbor",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new neighbor zone on the Expressway. Neighbor zones define connections to peer systems such as other Expressway nodes, Unified CM clusters, or gatekeepers with configurable H.323 and SIP protocol settings."
        },
        {
          "info": {
            "name": "Cisco Expressway Update a neighbor zone",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/common/zone/neighbor",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies an existing neighbor zone configuration on the Expressway including peer addresses, protocol settings, zone profile, and authentication options."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a neighbor zone",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/provisioning/common/zone/neighbor"
          },
          "docs": "Removes a neighbor zone from the Expressway configuration."
        },
        {
          "info": {
            "name": "Cisco Expressway List all DNS zones",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/zone/dns"
          },
          "docs": "Retrieves all DNS zones configured on the Expressway. DNS zones enable endpoint location through DNS lookups for SIP and H.323 calls."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a DNS zone",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/common/zone/dns",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new DNS zone on the Expressway for endpoint discovery via DNS lookups. Configurable for H.323 and SIP protocols with fallback transport and TLS mapping options."
        }
      ]
    },
    {
      "info": {
        "name": "Search Rules",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway List all search rules",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/searchrule"
          },
          "docs": "Retrieves all search rules configured on the Expressway. Search rules define how the Expressway routes incoming search requests to the appropriate target zones or policy services, with configurable alias pattern matching, priority, and protocol filtering."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a search rule",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/common/searchrule",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new search rule on the Expressway. Search rules determine how incoming calls are routed to target zones based on alias patterns, source zones, and protocol type. Each search rule has a configurable priority that determines its evaluation order."
        },
        {
          "info": {
            "name": "Cisco Expressway Update a search rule",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/common/searchrule",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies an existing search rule configuration on the Expressway including the alias pattern, target zone, priority, and protocol filter settings."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a search rule",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/provisioning/common/searchrule"
          },
          "docs": "Removes a search rule from the Expressway configuration."
        }
      ]
    },
    {
      "info": {
        "name": "Transforms",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway List all pre-search transforms",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/transform"
          },
          "docs": "Retrieves all pre-search transforms configured on the Expressway. Pre-search transforms modify the destination alias in an incoming search request before any searches are sent to external zones, enabling alias normalization and rewriting."
        },
        {
          "info": {
            "name": "Cisco Expressway Create a pre-search transform",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}/api/provisioning/common/transform",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new pre-search transform on the Expressway. Transforms are applied to incoming search requests to modify the destination alias before routing decisions are made, using pattern matching and replacement strings."
        },
        {
          "info": {
            "name": "Cisco Expressway Update a pre-search transform",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/common/transform",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies an existing pre-search transform configuration on the Expressway including the alias pattern, replacement string, and priority."
        },
        {
          "info": {
            "name": "Cisco Expressway Delete a pre-search transform",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}/api/provisioning/common/transform"
          },
          "docs": "Removes a pre-search transform from the Expressway configuration."
        }
      ]
    },
    {
      "info": {
        "name": "SIP",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Cisco Expressway Retrieve SIP configuration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}/api/provisioning/common/sip/configuration"
          },
          "docs": "Returns the current SIP protocol configuration for the Expressway including SIP mode, listening ports, transport protocols, registration settings, and session timer parameters."
        },
        {
          "info": {
            "name": "Cisco Expressway Update SIP configuration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}/api/provisioning/common/sip/configuration",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies the SIP protocol configuration on the Expressway including SIP mode, transport settings, registration proxy behavior, and session timer parameters."
        }
      ]
    }
  ],
  "bundled": true
}