Fortinet black logo

Edit a site

Edit a site

Method

URL

Description

Arguments

Outputs

PUT

device/site/{Site ID}/

Edit a site

Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

Parameter

Type

Required

Description

customerId

int

Y

The organization ID

name

string

Y

The unique name for this site

contactName

string

N

The primary contact name for this site

email

email

N

The primary contact email for this site

phone

phone

N

The primary contact phone number for this site

sandbox

bool

N

Enable or disable sandbox capability

switches

array

N

A list of managed FortiSwitch IDs to associate with this site

vdoms

array

N

A list of managed FortiManager IDs to associate with this site

aps

array

N

A list of managed FortiAP IDs to associate with this site

Outputs

Parameter

Type

Description

results

JSON array

The site data.

Example request

curl -k -X PUT -H "Content-Type: application/json" -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" -d '{"name":"site3","contactName":"aaa","email":"aaa@test.com","phone":"","sandbox":false,"vdoms":[],"aps":[],"switches":[],"customerId":"1"}' "https://<ip_address>/fpc/v1/api/device/site/4/"

Example response

{

"status" : {

"code" : 0,

"message" : "success"

}

}

Edit a site

Method

URL

Description

Arguments

Outputs

PUT

device/site/{Site ID}/

Edit a site

Site ID

JSON array

Arguments (URL)

Parameter

Type

Description

Site ID

int

Site ID

Arguments (JSON payload)

Parameter

Type

Required

Description

customerId

int

Y

The organization ID

name

string

Y

The unique name for this site

contactName

string

N

The primary contact name for this site

email

email

N

The primary contact email for this site

phone

phone

N

The primary contact phone number for this site

sandbox

bool

N

Enable or disable sandbox capability

switches

array

N

A list of managed FortiSwitch IDs to associate with this site

vdoms

array

N

A list of managed FortiManager IDs to associate with this site

aps

array

N

A list of managed FortiAP IDs to associate with this site

Outputs

Parameter

Type

Description

results

JSON array

The site data.

Example request

curl -k -X PUT -H "Content-Type: application/json" -H "Authorization: Token 7f89ef48dc5bca218a8ac0268653ffafa74ce6a6ed7a8a703e113b13219b18a6" -d '{"name":"site3","contactName":"aaa","email":"aaa@test.com","phone":"","sandbox":false,"vdoms":[],"aps":[],"switches":[],"customerId":"1"}' "https://<ip_address>/fpc/v1/api/device/site/4/"

Example response

{

"status" : {

"code" : 0,

"message" : "success"

}

}