Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

NetBox

NetBox vpn API

The vpn API from NetBox — 20 operation(s) for vpn.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBox vpn API is one of 14 APIs that NetBox publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include vpn. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 90 operations across 20 paths, and defines 69 schemas. It is described by OpenAPI 3.0.3, at version 4.5.9 (4.5).

Requests are made against the base URL https://demo.netbox.dev/api.

90 operations 20 paths 69 schemas 20 DELETE20 GET20 PATCH10 POST20 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
4.5.9 (4.5)
Base URL
https://demo.netbox.dev/api
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox vpn API declares 2 security schemes for authenticating requests. An API key is passed in the cookie as sessionid (cookieAuth). An API key is passed in the header as Authorization (tokenAuth).

  • tokenAuth — Token (v1) or Bearer . (v2)

Paths & Operations 90

Across 20 paths, the API surfaces 90 operations — 20 DELETE, 20 GET, 20 PATCH, 10 POST, 20 PUT. Each is listed below with its method, path, parameters, and response codes.

vpn 90
GET
/api/vpn/ike-policies/
Get a list of IKE policy objects.
vpn_ike_policies_list 107 params → 200
POST
/api/vpn/ike-policies/
Post a list of IKE policy objects.
vpn_ike_policies_create body → 201
PUT
/api/vpn/ike-policies/
Put a list of IKE policy objects.
vpn_ike_policies_bulk_update body → 200
PATCH
/api/vpn/ike-policies/
Patch a list of IKE policy objects.
vpn_ike_policies_bulk_partial_update body → 200
DELETE
/api/vpn/ike-policies/
Delete a list of IKE policy objects.
vpn_ike_policies_bulk_destroy body → 204
GET
/api/vpn/ike-policies/{id}/
Get a IKE policy object.
vpn_ike_policies_retrieve 1 param → 200
PUT
/api/vpn/ike-policies/{id}/
Put a IKE policy object.
vpn_ike_policies_update 1 param body → 200
PATCH
/api/vpn/ike-policies/{id}/
Patch a IKE policy object.
vpn_ike_policies_partial_update 1 param body → 200
DELETE
/api/vpn/ike-policies/{id}/
Delete a IKE policy object.
vpn_ike_policies_destroy 1 param → 204
GET
/api/vpn/ike-proposals/
Get a list of IKE proposal objects.
vpn_ike_proposals_list 128 params → 200
POST
/api/vpn/ike-proposals/
Post a list of IKE proposal objects.
vpn_ike_proposals_create body → 201
PUT
/api/vpn/ike-proposals/
Put a list of IKE proposal objects.
vpn_ike_proposals_bulk_update body → 200
PATCH
/api/vpn/ike-proposals/
Patch a list of IKE proposal objects.
vpn_ike_proposals_bulk_partial_update body → 200
DELETE
/api/vpn/ike-proposals/
Delete a list of IKE proposal objects.
vpn_ike_proposals_bulk_destroy body → 204
GET
/api/vpn/ike-proposals/{id}/
Get a IKE proposal object.
vpn_ike_proposals_retrieve 1 param → 200
PUT
/api/vpn/ike-proposals/{id}/
Put a IKE proposal object.
vpn_ike_proposals_update 1 param body → 200
PATCH
/api/vpn/ike-proposals/{id}/
Patch a IKE proposal object.
vpn_ike_proposals_partial_update 1 param body → 200
DELETE
/api/vpn/ike-proposals/{id}/
Delete a IKE proposal object.
vpn_ike_proposals_destroy 1 param → 204
GET
/api/vpn/ipsec-policies/
Get a list of IPSec policy objects.
vpn_ipsec_policies_list 82 params → 200
POST
/api/vpn/ipsec-policies/
Post a list of IPSec policy objects.
vpn_ipsec_policies_create body → 201
PUT
/api/vpn/ipsec-policies/
Put a list of IPSec policy objects.
vpn_ipsec_policies_bulk_update body → 200
PATCH
/api/vpn/ipsec-policies/
Patch a list of IPSec policy objects.
vpn_ipsec_policies_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-policies/
Delete a list of IPSec policy objects.
vpn_ipsec_policies_bulk_destroy body → 204
GET
/api/vpn/ipsec-policies/{id}/
Get a IPSec policy object.
vpn_ipsec_policies_retrieve 1 param → 200
PUT
/api/vpn/ipsec-policies/{id}/
Put a IPSec policy object.
vpn_ipsec_policies_update 1 param body → 200
PATCH
/api/vpn/ipsec-policies/{id}/
Patch a IPSec policy object.
vpn_ipsec_policies_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-policies/{id}/
Delete a IPSec policy object.
vpn_ipsec_policies_destroy 1 param → 204
GET
/api/vpn/ipsec-profiles/
Get a list of IPSec profile objects.
vpn_ipsec_profiles_list 87 params → 200
POST
/api/vpn/ipsec-profiles/
Post a list of IPSec profile objects.
vpn_ipsec_profiles_create body → 201
PUT
/api/vpn/ipsec-profiles/
Put a list of IPSec profile objects.
vpn_ipsec_profiles_bulk_update body → 200
PATCH
/api/vpn/ipsec-profiles/
Patch a list of IPSec profile objects.
vpn_ipsec_profiles_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-profiles/
Delete a list of IPSec profile objects.
vpn_ipsec_profiles_bulk_destroy body → 204
GET
/api/vpn/ipsec-profiles/{id}/
Get a IPSec profile object.
vpn_ipsec_profiles_retrieve 1 param → 200
PUT
/api/vpn/ipsec-profiles/{id}/
Put a IPSec profile object.
vpn_ipsec_profiles_update 1 param body → 200
PATCH
/api/vpn/ipsec-profiles/{id}/
Patch a IPSec profile object.
vpn_ipsec_profiles_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-profiles/{id}/
Delete a IPSec profile object.
vpn_ipsec_profiles_destroy 1 param → 204
GET
/api/vpn/ipsec-proposals/
Get a list of IPSec proposal objects.
vpn_ipsec_proposals_list 110 params → 200
POST
/api/vpn/ipsec-proposals/
Post a list of IPSec proposal objects.
vpn_ipsec_proposals_create body → 201
PUT
/api/vpn/ipsec-proposals/
Put a list of IPSec proposal objects.
vpn_ipsec_proposals_bulk_update body → 200
PATCH
/api/vpn/ipsec-proposals/
Patch a list of IPSec proposal objects.
vpn_ipsec_proposals_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-proposals/
Delete a list of IPSec proposal objects.
vpn_ipsec_proposals_bulk_destroy body → 204
GET
/api/vpn/ipsec-proposals/{id}/
Get a IPSec proposal object.
vpn_ipsec_proposals_retrieve 1 param → 200
PUT
/api/vpn/ipsec-proposals/{id}/
Put a IPSec proposal object.
vpn_ipsec_proposals_update 1 param body → 200
PATCH
/api/vpn/ipsec-proposals/{id}/
Patch a IPSec proposal object.
vpn_ipsec_proposals_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-proposals/{id}/
Delete a IPSec proposal object.
vpn_ipsec_proposals_destroy 1 param → 204
GET
/api/vpn/l2vpn-terminations/
Get a list of L2VPN termination objects.
vpn_l2vpn_terminations_list 78 params → 200
POST
/api/vpn/l2vpn-terminations/
Post a list of L2VPN termination objects.
vpn_l2vpn_terminations_create body → 201
PUT
/api/vpn/l2vpn-terminations/
Put a list of L2VPN termination objects.
vpn_l2vpn_terminations_bulk_update body → 200
PATCH
/api/vpn/l2vpn-terminations/
Patch a list of L2VPN termination objects.
vpn_l2vpn_terminations_bulk_partial_update body → 200
DELETE
/api/vpn/l2vpn-terminations/
Delete a list of L2VPN termination objects.
vpn_l2vpn_terminations_bulk_destroy body → 204
GET
/api/vpn/l2vpn-terminations/{id}/
Get a L2VPN termination object.
vpn_l2vpn_terminations_retrieve 1 param → 200
PUT
/api/vpn/l2vpn-terminations/{id}/
Put a L2VPN termination object.
vpn_l2vpn_terminations_update 1 param body → 200
PATCH
/api/vpn/l2vpn-terminations/{id}/
Patch a L2VPN termination object.
vpn_l2vpn_terminations_partial_update 1 param body → 200
DELETE
/api/vpn/l2vpn-terminations/{id}/
Delete a L2VPN termination object.
vpn_l2vpn_terminations_destroy 1 param → 204
GET
/api/vpn/l2vpns/
Get a list of L2VPN objects.
vpn_l2vpns_list 134 params → 200
POST
/api/vpn/l2vpns/
Post a list of L2VPN objects.
vpn_l2vpns_create body → 201
PUT
/api/vpn/l2vpns/
Put a list of L2VPN objects.
vpn_l2vpns_bulk_update body → 200
PATCH
/api/vpn/l2vpns/
Patch a list of L2VPN objects.
vpn_l2vpns_bulk_partial_update body → 200
DELETE
/api/vpn/l2vpns/
Delete a list of L2VPN objects.
vpn_l2vpns_bulk_destroy body → 204
GET
/api/vpn/l2vpns/{id}/
Get a L2VPN object.
vpn_l2vpns_retrieve 1 param → 200
PUT
/api/vpn/l2vpns/{id}/
Put a L2VPN object.
vpn_l2vpns_update 1 param body → 200
PATCH
/api/vpn/l2vpns/{id}/
Patch a L2VPN object.
vpn_l2vpns_partial_update 1 param body → 200
DELETE
/api/vpn/l2vpns/{id}/
Delete a L2VPN object.
vpn_l2vpns_destroy 1 param → 204
GET
/api/vpn/tunnel-groups/
Get a list of tunnel group objects.
vpn_tunnel_groups_list 85 params → 200
POST
/api/vpn/tunnel-groups/
Post a list of tunnel group objects.
vpn_tunnel_groups_create body → 201
PUT
/api/vpn/tunnel-groups/
Put a list of tunnel group objects.
vpn_tunnel_groups_bulk_update body → 200
PATCH
/api/vpn/tunnel-groups/
Patch a list of tunnel group objects.
vpn_tunnel_groups_bulk_partial_update body → 200
DELETE
/api/vpn/tunnel-groups/
Delete a list of tunnel group objects.
vpn_tunnel_groups_bulk_destroy body → 204
GET
/api/vpn/tunnel-groups/{id}/
Get a tunnel group object.
vpn_tunnel_groups_retrieve 1 param → 200
PUT
/api/vpn/tunnel-groups/{id}/
Put a tunnel group object.
vpn_tunnel_groups_update 1 param body → 200
PATCH
/api/vpn/tunnel-groups/{id}/
Patch a tunnel group object.
vpn_tunnel_groups_partial_update 1 param body → 200
DELETE
/api/vpn/tunnel-groups/{id}/
Delete a tunnel group object.
vpn_tunnel_groups_destroy 1 param → 204
GET
/api/vpn/tunnel-terminations/
Get a list of tunnel termination objects.
vpn_tunnel_terminations_list 68 params → 200
POST
/api/vpn/tunnel-terminations/
Post a list of tunnel termination objects.
vpn_tunnel_terminations_create body → 201
PUT
/api/vpn/tunnel-terminations/
Put a list of tunnel termination objects.
vpn_tunnel_terminations_bulk_update body → 200
PATCH
/api/vpn/tunnel-terminations/
Patch a list of tunnel termination objects.
vpn_tunnel_terminations_bulk_partial_update body → 200
DELETE
/api/vpn/tunnel-terminations/
Delete a list of tunnel termination objects.
vpn_tunnel_terminations_bulk_destroy body → 204
GET
/api/vpn/tunnel-terminations/{id}/
Get a tunnel termination object.
vpn_tunnel_terminations_retrieve 1 param → 200
PUT
/api/vpn/tunnel-terminations/{id}/
Put a tunnel termination object.
vpn_tunnel_terminations_update 1 param body → 200
PATCH
/api/vpn/tunnel-terminations/{id}/
Patch a tunnel termination object.
vpn_tunnel_terminations_partial_update 1 param body → 200
DELETE
/api/vpn/tunnel-terminations/{id}/
Delete a tunnel termination object.
vpn_tunnel_terminations_destroy 1 param → 204
GET
/api/vpn/tunnels/
Get a list of tunnel objects.
vpn_tunnels_list 121 params → 200
POST
/api/vpn/tunnels/
Post a list of tunnel objects.
vpn_tunnels_create body → 201
PUT
/api/vpn/tunnels/
Put a list of tunnel objects.
vpn_tunnels_bulk_update body → 200
PATCH
/api/vpn/tunnels/
Patch a list of tunnel objects.
vpn_tunnels_bulk_partial_update body → 200
DELETE
/api/vpn/tunnels/
Delete a list of tunnel objects.
vpn_tunnels_bulk_destroy body → 204
GET
/api/vpn/tunnels/{id}/
Get a tunnel object.
vpn_tunnels_retrieve 1 param → 200
PUT
/api/vpn/tunnels/{id}/
Put a tunnel object.
vpn_tunnels_update 1 param body → 200
PATCH
/api/vpn/tunnels/{id}/
Patch a tunnel object.
vpn_tunnels_partial_update 1 param body → 200
DELETE
/api/vpn/tunnels/{id}/
Delete a tunnel object.
vpn_tunnels_destroy 1 param → 204

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are L2VPN (19 properties), Tunnel (19 properties), IKEProposal (17 properties), IPSecProposal (16 properties). Each schema is shown below with its type and property counts.

PaginatedL2VPNTerminationList
object
4 properties 2 required
BriefIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
L2VPNTermination
object
Adds support for custom fields and tags.
12 properties 10 required
BriefIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedL2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties
BriefIPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BriefTunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
BriefTunnel
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PaginatedIPSecProfileList
object
4 properties 2 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedWritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
BriefL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 2 required
WritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
PaginatedTunnelList
object
4 properties 2 required
PatchedWritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties
IKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
PatchedWritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
IPSecProposal
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 7 required
PaginatedTunnelTerminationList
object
4 properties 2 required
L2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties 3 required
TunnelTermination
object
Adds support for custom fields and tags.
14 properties 10 required
PatchedWritableL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
BriefIKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PaginatedTunnelGroupList
object
4 properties 2 required
L2VPN
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 8 required
RouteTarget
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
IPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 10 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedWritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
BriefTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
Tunnel
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 10 required
PatchedWritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
IPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
NestedTag
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
7 properties 6 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
PaginatedL2VPNList
object
4 properties 2 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
PatchedTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
BriefOwnerRequest
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
2 properties 1 required
WritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
IPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 7 required
BriefTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
TunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 3 required
IPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
WritableL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 3 required
WritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 2 required
IKEProposal
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 10 required
IKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 8 required
PatchedWritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
PaginatedIKEPolicyList
object
4 properties 2 required
TunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
PatchedWritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
PaginatedIPSecProposalList
object
4 properties 2 required
WritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
BriefOwner
object
Extends the built-in ModelSerializer to enforce calling fullclean() on a copy of the associated instance during validation. (DRF does not do this by default; s…
5 properties 4 required
PaginatedIKEProposalList
object
4 properties 2 required
WritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
L2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
BriefIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefIPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PaginatedIPSecPolicyList
object
4 properties 2 required
IPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
IKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
TunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 3 required
WritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
WritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
NestedTagRequest
object
Represents an object related through a ForeignKey field. On write, it accepts a primary key (PK) value or a dictionary of attributes which can be used to uniqu…
3 properties 2 required
TunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-vpn-api-openapi.yml Raw ↑

Other APIs NetBox publishes across the network.

NetBox GraphQL API
AE Profile APIs.io
NetBox authentication-check API
AE Profile APIs.io
NetBox circuits API
AE Profile APIs.io
NetBox core API
AE Profile APIs.io
NetBox dcim API
AE Profile APIs.io
NetBox extras API
AE Profile APIs.io
NetBox ipam API
AE Profile APIs.io
NetBox schema API
AE Profile APIs.io
NetBox status API
AE Profile APIs.io
NetBox tenancy API
AE Profile APIs.io
NetBox users API
AE Profile APIs.io
NetBox virtualization API
AE Profile APIs.io
#vpn
← Back to N APIs
API Details
ID
netbox:netbox-vpn-api
Base URL
https://demo.netbox.dev/api
Docs
https://docs.netbox.dev/en/stable/
Provider
NetBox
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network