Sign in
Switch

Update

Update an existing Switch record by ID.

put/api/cp/switch/ip/{id}

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

company_idinteger

Company Id (references company.id)

ipstring ipv4

Ip

proxystring

Proxy

bandwidthinteger

Bandwidth

channelsinteger

Channels

cpsinteger

Cps

manufacturerstring

Manufacturer

versionstring

Version

protocolstring

Protocol

portstring

Port

codecstring

Codec

dial_patternstring

Dial Pattern

prefixstring required

Prefix

cli_prefixstring

Cli Prefix

stripinteger required

Strip

cli_stripinteger required

Cli Strip

directionstring[]

Direction

userstring

User

passstring

Pass

fromstring

From

rewriteobject

Rewrite

force_natinteger required

Force Nat

intercept_reinviteinteger required

Intercept Reinvite

flagsstring required

Flags

weightinteger

Weight

start_ipinteger

Start Ip

end_ipinteger

End Ip

iso3166_alpha_2string

Iso 3166 Alpha 2

Example request

{
  "id": 12345,
  "company_id": 1,
  "ip": "192.168.1.1",
  "proxy": "example_proxy",
  "bandwidth": 123,
  "channels": 123,
  "cps": 123,
  "manufacturer": "example_manufacturer",
  "version": "example_version",
  "protocol": "example_protocol",
  "port": "example_port",
  "codec": "example_codec",
  "dial_pattern": "example_dial_pattern",
  "prefix": "example_prefix",
  "cli_prefix": "example_cli_prefix",
  "strip": 123,
  "cli_strip": 123,
  "direction": "Ingress",
  "user": "example_user",
  "pass": "example_pass",
  "from": "example_from",
  "rewrite": "example_rewrite",
  "force_nat": 1,
  "intercept_reinvite": 1,
  "flags": "example_flags",
  "weight": 1,
  "start_ip": 123,
  "end_ip": 123,
  "iso3166_alpha_2": "example_iso3166_alpha_2"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes