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

NetBox Labs vpn API

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

NetBox Labs vpn API is one of 13 APIs that NetBox Labs 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 and authentication docs.

This API exposes 90 operations across 20 paths, and defines 91 schemas. It is described by OpenAPI 3.0.3, at version 4.6.5 (4.6).

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

90 operations 20 paths 91 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.6.5 (4.6)
Base URL
https://demo.netbox.dev/api/
Authentication
API Key, API Key
License
Apache v2 License
Resource Areas
1

Authentication & Security 2

NetBox Labs 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 111 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 4 params → 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 132 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 4 params → 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 86 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 4 params → 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 91 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 4 params → 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 114 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 4 params → 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 82 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 4 params → 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 138 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 4 params → 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 89 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 4 params → 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 72 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 4 params → 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 125 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 4 params → 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 91

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

BriefIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
IPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
WritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
PaginatedIPSecProposalList
object
4 properties 2 required
PaginatedIPSecProfileList
object
4 properties 2 required
BulkTunnelTerminationRequest
object
Adds support for custom fields and tags.
8 properties 4 required
BriefIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
PatchedBulkIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
PaginatedL2VPNTerminationList
object
4 properties 2 required
L2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
PatchedWritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties
PatchedBulkIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 1 required
PatchedBulkIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
L2VPNTermination
object
Adds support for custom fields and tags.
12 properties 10 required
PaginatedIPSecPolicyList
object
4 properties 2 required
IKEProposal
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 10 required
BulkTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 4 required
IPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 7 required
NestedIPAddress
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…
6 properties 6 required
PatchedBulkIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 1 required
PaginatedTunnelList
object
4 properties 2 required
BriefTunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
6 properties 5 required
L2VPN
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 8 required
WritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 2 required
PatchedBulkTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 1 required
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 6 required
BulkL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 3 required
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 required
PatchedL2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties
IKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
PaginatedIKEPolicyList
object
4 properties 2 required
PaginatedL2VPNList
object
4 properties 2 required
BriefIKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PatchedWritableL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties
IKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
BriefTunnel
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
BriefTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
TunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 3 required
IPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 10 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
PatchedWritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
RouteTarget
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
PatchedBulkL2VPNTerminationRequest
object
Adds support for custom fields and tags.
6 properties 1 required
WritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 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
PatchedWritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
IPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
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
BriefIPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
IPSecProposal
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 7 required
PatchedBulkTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 1 required
BulkL2VPNTerminationRequest
object
Adds support for custom fields and tags.
6 properties 4 required
PatchedBulkTunnelTerminationRequest
object
Adds support for custom fields and tags.
8 properties 1 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
4 properties 1 required
TunnelTermination
object
Adds support for custom fields and tags.
14 properties 10 required
WritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
BriefIPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PatchedWritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
IPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
BulkIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 2 required
PaginatedTunnelGroupList
object
4 properties 2 required
WritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
Tunnel
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 10 required
PaginatedIKEProposalList
object
4 properties 2 required
IKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 8 required
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 2 required
TunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
PatchedWritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
PatchedBulkL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 1 required
PatchedWritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
PatchedBulkIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 1 required
BriefTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
NestedIPAddressRequest
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…
1 property 1 required
TunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 3 required
WritableL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 3 required
BulkIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 3 required
BriefIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
BulkIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 5 required
PatchedTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
PatchedWritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
L2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties 3 required
WritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
BulkIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 2 required
WritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
PaginatedTunnelTerminationList
object
4 properties 2 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
BulkIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 5 required
BulkTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
8 properties 3 required
TunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbox-labs-vpn-api-openapi.yml Raw ↑

Other APIs NetBox Labs publishes across the network.

NetBox Labs authentication-check API
NetBox Labs circuits API
NetBox Labs core API
NetBox Labs dcim API
NetBox Labs extras API
NetBox Labs ipam API
NetBox Labs schema API
NetBox Labs status API
NetBox Labs tenancy API
NetBox Labs users API
NetBox Labs virtualization API
NetBox Labs wireless API