How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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.2.0, 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.2.0
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/
Vpn ike policies list
vpn_ike_policies_list 107 params → 200
POST
/api/vpn/ike-policies/
Vpn ike policies create
vpn_ike_policies_create body → 201
PUT
/api/vpn/ike-policies/
Vpn ike policies bulk update
vpn_ike_policies_bulk_update body → 200
PATCH
/api/vpn/ike-policies/
Vpn ike policies bulk partial update
vpn_ike_policies_bulk_partial_update body → 200
DELETE
/api/vpn/ike-policies/
Vpn ike policies bulk destroy
vpn_ike_policies_bulk_destroy body → 204
GET
/api/vpn/ike-policies/{id}/
Vpn ike policies retrieve
vpn_ike_policies_retrieve 1 param → 200
PUT
/api/vpn/ike-policies/{id}/
Vpn ike policies update
vpn_ike_policies_update 1 param body → 200
PATCH
/api/vpn/ike-policies/{id}/
Vpn ike policies partial update
vpn_ike_policies_partial_update 1 param body → 200
DELETE
/api/vpn/ike-policies/{id}/
Vpn ike policies destroy
vpn_ike_policies_destroy 1 param → 204
GET
/api/vpn/ike-proposals/
Vpn ike proposals list
vpn_ike_proposals_list 128 params → 200
POST
/api/vpn/ike-proposals/
Vpn ike proposals create
vpn_ike_proposals_create body → 201
PUT
/api/vpn/ike-proposals/
Vpn ike proposals bulk update
vpn_ike_proposals_bulk_update body → 200
PATCH
/api/vpn/ike-proposals/
Vpn ike proposals bulk partial update
vpn_ike_proposals_bulk_partial_update body → 200
DELETE
/api/vpn/ike-proposals/
Vpn ike proposals bulk destroy
vpn_ike_proposals_bulk_destroy body → 204
GET
/api/vpn/ike-proposals/{id}/
Vpn ike proposals retrieve
vpn_ike_proposals_retrieve 1 param → 200
PUT
/api/vpn/ike-proposals/{id}/
Vpn ike proposals update
vpn_ike_proposals_update 1 param body → 200
PATCH
/api/vpn/ike-proposals/{id}/
Vpn ike proposals partial update
vpn_ike_proposals_partial_update 1 param body → 200
DELETE
/api/vpn/ike-proposals/{id}/
Vpn ike proposals destroy
vpn_ike_proposals_destroy 1 param → 204
GET
/api/vpn/ipsec-policies/
Vpn ipsec policies list
vpn_ipsec_policies_list 82 params → 200
POST
/api/vpn/ipsec-policies/
Vpn ipsec policies create
vpn_ipsec_policies_create body → 201
PUT
/api/vpn/ipsec-policies/
Vpn ipsec policies bulk update
vpn_ipsec_policies_bulk_update body → 200
PATCH
/api/vpn/ipsec-policies/
Vpn ipsec policies bulk partial update
vpn_ipsec_policies_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-policies/
Vpn ipsec policies bulk destroy
vpn_ipsec_policies_bulk_destroy body → 204
GET
/api/vpn/ipsec-policies/{id}/
Vpn ipsec policies retrieve
vpn_ipsec_policies_retrieve 1 param → 200
PUT
/api/vpn/ipsec-policies/{id}/
Vpn ipsec policies update
vpn_ipsec_policies_update 1 param body → 200
PATCH
/api/vpn/ipsec-policies/{id}/
Vpn ipsec policies partial update
vpn_ipsec_policies_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-policies/{id}/
Vpn ipsec policies destroy
vpn_ipsec_policies_destroy 1 param → 204
GET
/api/vpn/ipsec-profiles/
Vpn ipsec profiles list
vpn_ipsec_profiles_list 87 params → 200
POST
/api/vpn/ipsec-profiles/
Vpn ipsec profiles create
vpn_ipsec_profiles_create body → 201
PUT
/api/vpn/ipsec-profiles/
Vpn ipsec profiles bulk update
vpn_ipsec_profiles_bulk_update body → 200
PATCH
/api/vpn/ipsec-profiles/
Vpn ipsec profiles bulk partial update
vpn_ipsec_profiles_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-profiles/
Vpn ipsec profiles bulk destroy
vpn_ipsec_profiles_bulk_destroy body → 204
GET
/api/vpn/ipsec-profiles/{id}/
Vpn ipsec profiles retrieve
vpn_ipsec_profiles_retrieve 1 param → 200
PUT
/api/vpn/ipsec-profiles/{id}/
Vpn ipsec profiles update
vpn_ipsec_profiles_update 1 param body → 200
PATCH
/api/vpn/ipsec-profiles/{id}/
Vpn ipsec profiles partial update
vpn_ipsec_profiles_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-profiles/{id}/
Vpn ipsec profiles destroy
vpn_ipsec_profiles_destroy 1 param → 204
GET
/api/vpn/ipsec-proposals/
Vpn ipsec proposals list
vpn_ipsec_proposals_list 110 params → 200
POST
/api/vpn/ipsec-proposals/
Vpn ipsec proposals create
vpn_ipsec_proposals_create body → 201
PUT
/api/vpn/ipsec-proposals/
Vpn ipsec proposals bulk update
vpn_ipsec_proposals_bulk_update body → 200
PATCH
/api/vpn/ipsec-proposals/
Vpn ipsec proposals bulk partial update
vpn_ipsec_proposals_bulk_partial_update body → 200
DELETE
/api/vpn/ipsec-proposals/
Vpn ipsec proposals bulk destroy
vpn_ipsec_proposals_bulk_destroy body → 204
GET
/api/vpn/ipsec-proposals/{id}/
Vpn ipsec proposals retrieve
vpn_ipsec_proposals_retrieve 1 param → 200
PUT
/api/vpn/ipsec-proposals/{id}/
Vpn ipsec proposals update
vpn_ipsec_proposals_update 1 param body → 200
PATCH
/api/vpn/ipsec-proposals/{id}/
Vpn ipsec proposals partial update
vpn_ipsec_proposals_partial_update 1 param body → 200
DELETE
/api/vpn/ipsec-proposals/{id}/
Vpn ipsec proposals destroy
vpn_ipsec_proposals_destroy 1 param → 204
GET
/api/vpn/l2vpn-terminations/
Vpn l2vpn terminations list
vpn_l2vpn_terminations_list 78 params → 200
POST
/api/vpn/l2vpn-terminations/
Vpn l2vpn terminations create
vpn_l2vpn_terminations_create body → 201
PUT
/api/vpn/l2vpn-terminations/
Vpn l2vpn terminations bulk update
vpn_l2vpn_terminations_bulk_update body → 200
PATCH
/api/vpn/l2vpn-terminations/
Vpn l2vpn terminations bulk partial update
vpn_l2vpn_terminations_bulk_partial_update body → 200
DELETE
/api/vpn/l2vpn-terminations/
Vpn l2vpn terminations bulk destroy
vpn_l2vpn_terminations_bulk_destroy body → 204
GET
/api/vpn/l2vpn-terminations/{id}/
Vpn l2vpn terminations retrieve
vpn_l2vpn_terminations_retrieve 1 param → 200
PUT
/api/vpn/l2vpn-terminations/{id}/
Vpn l2vpn terminations update
vpn_l2vpn_terminations_update 1 param body → 200
PATCH
/api/vpn/l2vpn-terminations/{id}/
Vpn l2vpn terminations partial update
vpn_l2vpn_terminations_partial_update 1 param body → 200
DELETE
/api/vpn/l2vpn-terminations/{id}/
Vpn l2vpn terminations destroy
vpn_l2vpn_terminations_destroy 1 param → 204
GET
/api/vpn/l2vpns/
Vpn l2vpns list
vpn_l2vpns_list 134 params → 200
POST
/api/vpn/l2vpns/
Vpn l2vpns create
vpn_l2vpns_create body → 201
PUT
/api/vpn/l2vpns/
Vpn l2vpns bulk update
vpn_l2vpns_bulk_update body → 200
PATCH
/api/vpn/l2vpns/
Vpn l2vpns bulk partial update
vpn_l2vpns_bulk_partial_update body → 200
DELETE
/api/vpn/l2vpns/
Vpn l2vpns bulk destroy
vpn_l2vpns_bulk_destroy body → 204
GET
/api/vpn/l2vpns/{id}/
Vpn l2vpns retrieve
vpn_l2vpns_retrieve 1 param → 200
PUT
/api/vpn/l2vpns/{id}/
Vpn l2vpns update
vpn_l2vpns_update 1 param body → 200
PATCH
/api/vpn/l2vpns/{id}/
Vpn l2vpns partial update
vpn_l2vpns_partial_update 1 param body → 200
DELETE
/api/vpn/l2vpns/{id}/
Vpn l2vpns destroy
vpn_l2vpns_destroy 1 param → 204
GET
/api/vpn/tunnel-groups/
Vpn tunnel groups list
vpn_tunnel_groups_list 85 params → 200
POST
/api/vpn/tunnel-groups/
Vpn tunnel groups create
vpn_tunnel_groups_create body → 201
PUT
/api/vpn/tunnel-groups/
Vpn tunnel groups bulk update
vpn_tunnel_groups_bulk_update body → 200
PATCH
/api/vpn/tunnel-groups/
Vpn tunnel groups bulk partial update
vpn_tunnel_groups_bulk_partial_update body → 200
DELETE
/api/vpn/tunnel-groups/
Vpn tunnel groups bulk destroy
vpn_tunnel_groups_bulk_destroy body → 204
GET
/api/vpn/tunnel-groups/{id}/
Vpn tunnel groups retrieve
vpn_tunnel_groups_retrieve 1 param → 200
PUT
/api/vpn/tunnel-groups/{id}/
Vpn tunnel groups update
vpn_tunnel_groups_update 1 param body → 200
PATCH
/api/vpn/tunnel-groups/{id}/
Vpn tunnel groups partial update
vpn_tunnel_groups_partial_update 1 param body → 200
DELETE
/api/vpn/tunnel-groups/{id}/
Vpn tunnel groups destroy
vpn_tunnel_groups_destroy 1 param → 204
GET
/api/vpn/tunnel-terminations/
Vpn tunnel terminations list
vpn_tunnel_terminations_list 68 params → 200
POST
/api/vpn/tunnel-terminations/
Vpn tunnel terminations create
vpn_tunnel_terminations_create body → 201
PUT
/api/vpn/tunnel-terminations/
Vpn tunnel terminations bulk update
vpn_tunnel_terminations_bulk_update body → 200
PATCH
/api/vpn/tunnel-terminations/
Vpn tunnel terminations bulk partial update
vpn_tunnel_terminations_bulk_partial_update body → 200
DELETE
/api/vpn/tunnel-terminations/
Vpn tunnel terminations bulk destroy
vpn_tunnel_terminations_bulk_destroy body → 204
GET
/api/vpn/tunnel-terminations/{id}/
Vpn tunnel terminations retrieve
vpn_tunnel_terminations_retrieve 1 param → 200
PUT
/api/vpn/tunnel-terminations/{id}/
Vpn tunnel terminations update
vpn_tunnel_terminations_update 1 param body → 200
PATCH
/api/vpn/tunnel-terminations/{id}/
Vpn tunnel terminations partial update
vpn_tunnel_terminations_partial_update 1 param body → 200
DELETE
/api/vpn/tunnel-terminations/{id}/
Vpn tunnel terminations destroy
vpn_tunnel_terminations_destroy 1 param → 204
GET
/api/vpn/tunnels/
Vpn tunnels list
vpn_tunnels_list 121 params → 200
POST
/api/vpn/tunnels/
Vpn tunnels create
vpn_tunnels_create body → 201
PUT
/api/vpn/tunnels/
Vpn tunnels bulk update
vpn_tunnels_bulk_update body → 200
PATCH
/api/vpn/tunnels/
Vpn tunnels bulk partial update
vpn_tunnels_bulk_partial_update body → 200
DELETE
/api/vpn/tunnels/
Vpn tunnels bulk destroy
vpn_tunnels_bulk_destroy body → 204
GET
/api/vpn/tunnels/{id}/
Vpn tunnels retrieve
vpn_tunnels_retrieve 1 param → 200
PUT
/api/vpn/tunnels/{id}/
Vpn tunnels update
vpn_tunnels_update 1 param body → 200
PATCH
/api/vpn/tunnels/{id}/
Vpn tunnels partial update
vpn_tunnels_partial_update 1 param body → 200
DELETE
/api/vpn/tunnels/{id}/
Vpn tunnels destroy
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), IKEPolicy (16 properties). Each schema is shown below with its type and property counts.

TunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 3 required
L2VPN
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 8 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
RouteTarget
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 7 required
TunnelTermination
object
Adds support for custom fields and tags.
14 properties 10 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
PaginatedTunnelTerminationList
object
4 properties 2 required
IKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 8 required
PaginatedTunnelList
object
4 properties 2 required
WritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
WritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 2 required
IPSecProposal
object
Base serializer class for models inheriting from PrimaryModel.
16 properties 7 required
PatchedWritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties
BriefIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefIPAddressRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefL2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 2 required
BriefIKEPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
PatchedWritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
BriefIPAddress
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
BriefTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
3 properties 2 required
IPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
PaginatedIPSecProfileList
object
4 properties 2 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
BriefL2VPN
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 5 required
TunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
14 properties 9 required
BriefTunnelGroup
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 6 required
PaginatedIPSecPolicyList
object
4 properties 2 required
PatchedWritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties
BriefTenant
object
Base serializer class for models inheriting from PrimaryModel.
6 properties 5 required
L2VPNTermination
object
Adds support for custom fields and tags.
12 properties 10 required
L2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties 3 required
PatchedL2VPNTerminationRequest
object
Adds support for custom fields and tags.
5 properties
BriefTunnel
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
PaginatedL2VPNTerminationList
object
4 properties 2 required
PaginatedIPSecProposalList
object
4 properties 2 required
IKEProposal
object
Base serializer class for models inheriting from PrimaryModel.
17 properties 10 required
PatchedWritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties
PaginatedIKEPolicyList
object
4 properties 2 required
L2VPNRequest
object
Base serializer class for models inheriting from PrimaryModel.
13 properties 2 required
PatchedTunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties
TunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties 3 required
IKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties 4 required
BriefIPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
WritableIPSecProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
IPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
15 properties 10 required
PatchedWritableTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
12 properties
PaginatedL2VPNList
object
4 properties 2 required
PatchedWritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 properties
IKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 2 required
PaginatedTunnelGroupList
object
4 properties 2 required
BriefIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
BriefIPSecProfile
object
Base serializer class for models inheriting from PrimaryModel.
5 properties 4 required
WritableTunnelTerminationRequest
object
Adds support for custom fields and tags.
7 properties 2 required
BriefTunnelRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
IPSecPolicy
object
Base serializer class for models inheriting from PrimaryModel.
14 properties 7 required
PaginatedIKEProposalList
object
4 properties 2 required
IPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties 1 required
TunnelGroupRequest
object
Base serializer class for models inheriting from OrganizationalModel.
7 properties 2 required
WritableIKEPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
10 properties 1 required
Tunnel
object
Base serializer class for models inheriting from PrimaryModel.
19 properties 10 required
WritableIPSecProfileRequest
object
Base serializer class for models inheriting from PrimaryModel.
9 properties 4 required
PatchedWritableIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
8 properties
BriefIPSecPolicyRequest
object
Base serializer class for models inheriting from PrimaryModel.
2 properties 1 required
WritableIKEProposalRequest
object
Base serializer class for models inheriting from PrimaryModel.
11 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
BriefTenantRequest
object
Base serializer class for models inheriting from PrimaryModel.
3 properties 2 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

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
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbox-vpn-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbox-vpn-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBox Vpn API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.