NetBox Labs vpn API

The vpn API from NetBox Labs — 20 operation(s) for vpn.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.0.3
info:
  title: NetBox REST authentication-check vpn API
  version: 4.6.5 (4.6)
  license:
    name: Apache v2 License
servers:
- url: ''
  description: NetBox
tags:
- name: vpn
paths:
  /api/vpn/ike-policies/:
    get:
      operationId: vpn_ike_policies_list
      description: Get a list of IKE policy objects.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: created
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: created_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: description
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__empty
        schema:
          type: boolean
      - in: query
        name: description__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: description__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: query
        name: id
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__empty
        schema:
          type: boolean
      - in: query
        name: id__gt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__gte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lt
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__lte
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: id__n
        schema:
          type: array
          items:
            type: integer
            format: int32
        explode: true
        style: form
      - in: query
        name: ike_proposal
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: ike_proposal__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: ike_proposal_id
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: ike_proposal_id__n
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: last_updated
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__empty
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__gte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lt
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__lte
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - in: query
        name: last_updated__n
        schema:
          type: array
          items:
            type: string
            format: date-time
        explode: true
        style: form
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: mode
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__empty
        schema:
          type: boolean
      - in: query
        name: mode__ic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__ie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__iew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__iregex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__isw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__n
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__nic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__nie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__niew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__nisw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: mode__regex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 64c1be7bdb2548ca
            nullable: true
        explode: true
        style: form
      - in: query
        name: modified_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: name
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__empty
        schema:
          type: boolean
      - in: query
        name: name__ic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__ie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__iregex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__isw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nic
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nie
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__niew
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__nisw
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: name__regex
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: owner
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner__n
        schema:
          type: array
          items:
            type: string
        description: Owner (name)
        explode: true
        style: form
      - in: query
        name: owner_group
        schema:
          type: array
          items:
            type: string
        description: Owner Group (name)
        explode: true
        style: form
      - in: query
        name: owner_group__n
        schema:
          type: array
          items:
            type: string
        description: Owner Group (name)
        explode: true
        style: form
      - in: query
        name: owner_group_id
        schema:
          type: array
          items:
            type: integer
        description: Owner Group (ID)
        explode: true
        style: form
      - in: query
        name: owner_group_id__n
        schema:
          type: array
          items:
            type: integer
        description: Owner Group (ID)
        explode: true
        style: form
      - in: query
        name: owner_id
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: owner_id__n
        schema:
          type: array
          items:
            type: integer
            nullable: true
        description: Owner (ID)
        explode: true
        style: form
      - in: query
        name: preshared_key
        schema:
          type: string
      - in: query
        name: preshared_key__ic
        schema:
          type: string
      - in: query
        name: preshared_key__ie
        schema:
          type: string
      - in: query
        name: preshared_key__iew
        schema:
          type: string
      - in: query
        name: preshared_key__iregex
        schema:
          type: string
      - in: query
        name: preshared_key__isw
        schema:
          type: string
      - in: query
        name: preshared_key__n
        schema:
          type: string
      - in: query
        name: preshared_key__nic
        schema:
          type: string
      - in: query
        name: preshared_key__nie
        schema:
          type: string
      - in: query
        name: preshared_key__niew
        schema:
          type: string
      - in: query
        name: preshared_key__nisw
        schema:
          type: string
      - in: query
        name: preshared_key__regex
        schema:
          type: string
      - in: query
        name: q
        schema:
          type: string
        description: Search
      - name: start
        required: false
        in: query
        description: 'Cursor-based pagination: return results with pk >= start, ordered by pk. Mutually exclusive with offset.'
        schema:
          type: integer
      - in: query
        name: tag
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag__n
        schema:
          type: array
          items:
            type: string
        explode: true
        style: form
      - in: query
        name: tag_id
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: tag_id__n
        schema:
          type: array
          items:
            type: integer
        explode: true
        style: form
      - in: query
        name: updated_by_request
        schema:
          type: string
          format: uuid
      - in: query
        name: version
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__ic
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__ie
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__iew
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__iregex
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__isw
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__n
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__nic
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__nie
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__niew
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__nisw
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      - in: query
        name: version__regex
        schema:
          type: array
          items:
            type: integer
            x-spec-enum-id: 00872b77916a1fde
        explode: true
        style: form
      tags:
      - vpn
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIKEPolicyList'
          description: ''
    post:
      operationId: vpn_ike_policies_create
      description: Post a list of IKE policy objects.
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableIKEPolicyRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableIKEPolicyRequest'
          multipart/form-data:
            schema:
              oneOf:
              - $ref: '#/components/schemas/WritableIKEPolicyRequest'
              - type: array
                items:
                  $ref: '#/components/schemas/WritableIKEPolicyRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKEPolicy'
          description: ''
    put:
      operationId: vpn_ike_policies_bulk_update
      description: Put a list of IKE policy objects.
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkIKEPolicyRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BulkIKEPolicyRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IKEPolicy'
          description: ''
    patch:
      operationId: vpn_ike_policies_bulk_partial_update
      description: Patch a list of IKE policy objects.
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkIKEPolicyRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/PatchedBulkIKEPolicyRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IKEPolicy'
          description: ''
    delete:
      operationId: vpn_ike_policies_bulk_destroy
      description: Delete a list of IKE policy objects.
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IKEPolicyRequest'
          multipart/form-data:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/IKEPolicyRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/vpn/ike-policies/{id}/:
    get:
      operationId: vpn_ike_policies_retrieve
      description: Get a IKE policy object.
      parameters:
      - in: query
        name: brief
        schema:
          type: boolean
        description: Return only brief fields for each object.
      - in: query
        name: fields
        schema:
          type: string
        description: 'Comma-separated list of fields to include in the response. Example: `fields=id,name`.'
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this IKE policy.
        required: true
      - in: query
        name: omit
        schema:
          type: string
        description: 'Comma-separated list of fields to exclude from the response. Example: `omit=description,tags`.'
      tags:
      - vpn
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKEPolicy'
          description: ''
    put:
      operationId: vpn_ike_policies_update
      description: Put a IKE policy object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this IKE policy.
        required: true
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WritableIKEPolicyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/WritableIKEPolicyRequest'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKEPolicy'
          description: ''
    patch:
      operationId: vpn_ike_policies_partial_update
      description: Patch a IKE policy object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this IKE policy.
        required: true
      tags:
      - vpn
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWritableIKEPolicyRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedWritableIKEPolicyRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IKEPolicy'
          description: ''
    delete:
      operationId: vpn_ike_policies_destroy
      description: Delete a IKE policy object.
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this IKE policy.
        required: true
      tags:
      - vpn
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /api/vpn/ike-proposals/:
    get:
      operationId: vpn_ike_proposals_list
      description: Get a list of IKE proposal objects.
      parameters:
      - in: query
        name: authentication_algorithm
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__empty
        schema:
          type: boolean
      - in: query
        name: authentication_algorithm__ic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__ie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__iew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__iregex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__isw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__n
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__nic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__nie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__niew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__nisw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_algorithm__regex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: 0a7ca69695b483a7
            nullable: true
        explode: true
        style: form
      - in: query
        name: authentication_method
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__empty
        schema:
          type: boolean
      - in: query
        name: authentication_method__ic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__ie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__iew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__iregex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__isw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__n
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__nic
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__nie
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__niew
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__nisw
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: authentication_method__regex
        schema:
          type: array
          items:
            type: string
            x-spec-enum-id: a21158c52d0c455a
        explode: true
        style: form
      - in: query
        name: brief
        schema:
 

# --- truncated at 32 KB (400 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/netbox-labs/refs/heads/main/openapi/netbox-labs-vpn-api-openapi.yml
NetBox Labs vpn API

Documentation

Specifications

Other Resources

OpenAPI Specification
