For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
      • POSTCreate SIP gateway
      • DELDelete SIP gateway
      • GETGet SIP gateway
      • GETList SIP gateway Addresses
      • GETList SIP gateways
      • PATCHUpdate SIP gateway
LogoLogoSignalWire Docs
Log inSign up
Support
Resource ManagementSIP Gateway

Update SIP gateway

|View as Markdown|Open in Claude|
PATCH
https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways/:id
PATCH
/api/fabric/resources/sip_gateways/:id
$curl -X PATCH https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways/id \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{}'
1{
2  "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
3  "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
4  "display_name": "My SIP Gateway",
5  "type": "sip_gateway",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "sip_gateway": {
9    "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
10    "uri": "user3@domain.com",
11    "name": "My SIP Gateway",
12    "ciphers": [
13      "AEAD_AES_256_GCM_8"
14    ],
15    "codecs": [
16      "OPUS"
17    ],
18    "encryption": "required"
19  }
20}
Updates a SIP Gateway by ID #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
Was this page helpful?
Previous

Create Subscriber SIP credential

Next
Built with

Updates a SIP Gateway by ID

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

Authentication

AuthorizationBasic
SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a SIP Gateway.

Request

This endpoint expects an object.
namestringOptional
Display name for the SIP Gateway.
uristringOptional
External SIP URI.
encryptionenumOptional
Specifies the encryption requirement for the SIP connection.
Allowed values:
cipherslist of enumsOptional
List of supported SIP ciphers.
Allowed values:
codecslist of enumsOptional
List of supported codecs for media transmission.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the resource.
project_idstringformat: "uuid"
Project ID associated with the resource.
display_namestring
Display name of the SIP Gateway.
typeenum
Type of the resource.
Allowed values:
created_atdatetime
Timestamp when the resource was created.
updated_atdatetime
Timestamp when the resource was last updated.
sip_gatewayobject
SIP Gateway configuration details.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)