Update VPN service

URI

/v2.0/vpn/vpnservices/{service-id}

HTTP method

PUT

Request parameter

Key	Description	Type	Required/optional
name	Human readable name for the VPN service. Does not have to be unique.	string	Optional
admin_state_up	Administrative state of the vpnservice. If false (down), port does not forward packets.	bool	Optional
description	Human readable description for the VPN service.	string	Optional

Example request


{
  "vpnservice": {
    "description": "Updated description"
  }
}

Response status

Status code	Description
200	Normal response codes
Unauthorized (401)	Error response codes
Bad Request (400)	Error response codes
Not Found (404)	Error response codes

Response body (normal status)


{
  "vpnservice": {
    "router_id": "881b7b30-4efb-407e-a162-5630a7af3595",
    "status": "ACTIVE",
    "name": "myvpn",
    "admin_state_up": true,
    "subnet_id": "25f8a35c-82d5-4f55-a45b-6965936b33f6",
    "tenant_id": "26de9cd6cae94c8cb9f79d660d628e1f",
    "id": "41bfef97-af4e-4f6b-a5d3-4678859d2485",
    "description": "Updated description",
    "availability_zone": "AZ1"
  }
}

Description of response body (normal status)

Item	Description
router_id	Router ID to which the VPN service is inserted.
status	Indicates whether IPsec VPN service is currently operational. Possible values include: ACTIVE, DOWN, BUILD, ERROR, PENDING_CREATE, PENDING_UPDATE, or PENDING_DELETE.
name	Human readable name for the VPN service. Does not have to be unique.
admin_state_up	Administrative state of the vpnservice. If false (down), port does not forward packets.
subnet_id	The subnet on which the project wants the VPN service.
tenant_id	Owner of the VPN service. Only admin users can specify a project identifier other than their own.
id	Unique identifier for the VPN Service object.
description	Human readable description for the VPN service.
availability_zone	The Availability Zone name.