Skip to main content

Update a Site (v3.0)

PUT 
/v3.0/api/tenants/:tenant_id/sites/:site_id/admin_state

Update an existing site.

Request​

Path Parameters

    tenant_id stringrequired

    The tenant ID.

    site_id stringrequired

    ID of the site. More details on the site can be retrieved by querying the sites API.

Body

Details of the site to update

    address Address

    The address of the site.

    city string

    The name of the city. Max size = 100.

    country string

    The name of the country. Max size = 100.

    post_code string

    The postal code. Max size = 100.

    state string

    The name of the state. Max size = 100.

    street string

    The name of the street. Max size = 100.

    street2 string

    The name of the street. Max size = 100.

    admin_state stringrequired

    The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.

    description

    Description for the site (Max size = 1024).

    element_cluster_role stringrequired

    This attribute describes the type i.e. SPOKE or HUB.

    id string

    The ID.

    location Location

    The geographical cordinates for the site address.

    description

    The decsription of the location.

    latitude float

    The latitude of the location. Max range = 90.

    longitude float

    The longitude of the location. Max range = 180.

    name stringrequired

    The site name (Max size = 128).

    policy_set_id string

    The ID for the Original Network Policy Set. Can be retrieved using policysets API.

    security_policyset_id string

    The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.

    service_binding string

    Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

Responses​

Successful Operation

Schema
    address Address

    The address of the site.

    city string

    The name of the city. Max size = 100.

    country string

    The name of the country. Max size = 100.

    post_code string

    The postal code. Max size = 100.

    state string

    The name of the state. Max size = 100.

    street string

    The name of the street. Max size = 100.

    street2 string

    The name of the street. Max size = 100.

    admin_state stringrequired

    The site mode of operation, can be in one of three states: Active - the site is in Control mode and network policy is applied. Monitor - the site is in Analytics mode, no network policy is applied. Disabled: the site is disabled.

    description

    Description for the site (Max size = 1024).

    element_cluster_role stringrequired

    This attribute describes the type i.e. SPOKE or HUB.

    id string

    The ID.

    location Location

    The geographical cordinates for the site address.

    description

    The decsription of the location.

    latitude float

    The latitude of the location. Max range = 90.

    longitude float

    The longitude of the location. Max range = 180.

    name stringrequired

    The site name (Max size = 128).

    policy_set_id string

    The ID for the Original Network Policy Set. Can be retrieved using policysets API.

    security_policyset_id string

    The ID for the Original Security Policy Set. Can be retrieved using securitypolicysets API.

    service_binding string

    Bind a site to a set of domains. Can be retrieved using sericebindingmaps API.

Loading...