API Reference
API Reference

Update Organization Sip Ip Range

Update a SIP IP range. The verified status is managed by Syllable only.

PUT/api/v1/organizations/sip_ip_ranges/{sip_ip_range_id}

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

sip_ip_range_id integer path required

Request body

application/json

body OrganizationSipIpRangeUpdate required
2 fields
typeenum<string> | nulloptional

The SIP IP range type

Allowed values ["signaling","media"]
ip_rangestring (ipv4network) | string (ipv6network) | nulloptional

The SIP IP range in CIDR notation

3 options
Option 1string (ipv4network)optional
Option 2string (ipv6network)optional
Option 3nulloptional
Request example
{
  "type": "string",
  "ip_range": "string"
}

Responses

200Successful Response

application/json

response OrganizationSipIpRange required
8 fields
typeenum<string>required

The SIP IP range type

Allowed values ["signaling","media"]
ip_rangestring (ipv4network) | string (ipv6network)required

The SIP IP range in CIDR notation

2 options
Option 1string (ipv4network)required
Option 2string (ipv6network)required
idintegerrequired

The organization SIP IP range ID

organization_idintegerrequired

The Organization ID

verifiedbooleanrequired

Whether Syllable has verified this SIP IP range.Verification implies that the Syllable team has updated the firewall rules on the SBCs, confirmed traffic is correctly established from/to the customer network and calls to Syllable agents are working.

created_atstring (date-time) | nulloptional

The timestamp when the range was created

updated_atstring (date-time) | nulloptional

The timestamp when the range was last updated

deleted_atstring (date-time) | nulloptional

The timestamp when the IP was deleted

Response example
{
  "type": "string",
  "ip_range": "string",
  "id": 0,
  "organization_id": 0,
  "verified": true,
  "created_at": "string",
  "updated_at": "string",
  "deleted_at": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}