openapi: 3.0.3 info: title: NetBox REST authentication-check vpn API version: 4.5.9 (4.5) 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: 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: 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 - 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 - 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/IKEPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IKEPolicyRequest' 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/IKEPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IKEPolicyRequest' 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: path name: id schema: type: integer description: A unique integer value identifying this IKE policy. required: true 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: 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: encryption_algorithm schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__empty schema: type: boolean - in: query name: encryption_algorithm__ic schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__ie schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__iew schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__iregex schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__isw schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__n schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__nic schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__nie schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__niew schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__nisw schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: encryption_algorithm__regex schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 explode: true style: form - in: query name: group schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__ic schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__ie schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__iew schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__iregex schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__isw schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__n schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__nic schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__nie schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__niew schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__nisw schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - in: query name: group__regex schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 description: Diffie-Hellman group ID explode: true style: form - 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_policy schema: type: array items: type: string description: IKE policy (name) explode: true style: form - in: query name: ike_policy__n schema: type: array items: type: string description: IKE policy (name) explode: true style: form - in: query name: ike_policy_id schema: type: array items: type: integer description: IKE policy (ID) explode: true style: form - in: query name: ike_policy_id__n schema: type: array items: type: integer description: IKE policy (ID) 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: 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 - 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: q schema: type: string description: Search - in: query name: sa_lifetime schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime__empty schema: type: boolean - in: query name: sa_lifetime__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime__n schema: type: array items: type: integer format: int32 explode: true style: form - 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 tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIKEProposalList' description: '' post: operationId: vpn_ike_proposals_create description: Post a list of IKE proposal objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIKEProposalRequest' - type: array items: $ref: '#/components/schemas/WritableIKEProposalRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIKEProposalRequest' - type: array items: $ref: '#/components/schemas/WritableIKEProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IKEProposal' description: '' put: operationId: vpn_ike_proposals_bulk_update description: Put a list of IKE proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IKEProposal' description: '' patch: operationId: vpn_ike_proposals_bulk_partial_update description: Patch a list of IKE proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IKEProposal' description: '' delete: operationId: vpn_ike_proposals_bulk_destroy description: Delete a list of IKE proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IKEProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ike-proposals/{id}/: get: operationId: vpn_ike_proposals_retrieve description: Get a IKE proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IKE proposal. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IKEProposal' description: '' put: operationId: vpn_ike_proposals_update description: Put a IKE proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IKE proposal. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIKEProposalRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIKEProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IKEProposal' description: '' patch: operationId: vpn_ike_proposals_partial_update description: Patch a IKE proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IKE proposal. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIKEProposalRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIKEProposalRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IKEProposal' description: '' delete: operationId: vpn_ike_proposals_destroy description: Delete a IKE proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IKE proposal. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-policies/: get: operationId: vpn_ipsec_policies_list description: Get a list of IPSec policy objects. parameters: - 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: 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: ipsec_proposal schema: type: array items: type: string explode: true style: form - in: query name: ipsec_proposal__n schema: type: array items: type: string explode: true style: form - in: query name: ipsec_proposal_id schema: type: array items: type: integer explode: true style: form - in: query name: ipsec_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: 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 - 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: pfs_group schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__ic schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__ie schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__iew schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__iregex schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__isw schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__n schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__nic schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__nie schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__niew schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__nisw schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: pfs_group__regex schema: type: array items: type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: Diffie-Hellman group for Perfect Forward Secrecy explode: true style: form - in: query name: q schema: type: string description: Search - 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 tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIPSecPolicyList' description: '' post: operationId: vpn_ipsec_policies_create description: Post a list of IPSec policy objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecPolicyRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecPolicyRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecPolicyRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IPSecPolicy' description: '' put: operationId: vpn_ipsec_policies_bulk_update description: Put a list of IPSec policy objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecPolicy' description: '' patch: operationId: vpn_ipsec_policies_bulk_partial_update description: Patch a list of IPSec policy objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecPolicy' description: '' delete: operationId: vpn_ipsec_policies_bulk_destroy description: Delete a list of IPSec policy objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-policies/{id}/: get: operationId: vpn_ipsec_policies_retrieve description: Get a IPSec policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec policy. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecPolicy' description: '' put: operationId: vpn_ipsec_policies_update description: Put a IPSec policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec policy. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPSecPolicyRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIPSecPolicyRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecPolicy' description: '' patch: operationId: vpn_ipsec_policies_partial_update description: Patch a IPSec policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec policy. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPSecPolicyRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIPSecPolicyRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecPolicy' description: '' delete: operationId: vpn_ipsec_policies_destroy description: Delete a IPSec policy object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec policy. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-profiles/: get: operationId: vpn_ipsec_profiles_list description: Get a list of IPSec profile objects. parameters: - 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: 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_policy schema: type: array items: type: string description: IKE policy (name) explode: true style: form - in: query name: ike_policy__n schema: type: array items: type: string description: IKE policy (name) explode: true style: form - in: query name: ike_policy_id schema: type: array items: type: integer description: IKE policy (ID) explode: true style: form - in: query name: ike_policy_id__n schema: type: array items: type: integer description: IKE policy (ID) explode: true style: form - in: query name: ipsec_policy schema: type: array items: type: string description: IPSec policy (name) explode: true style: form - in: query name: ipsec_policy__n schema: type: array items: type: string description: IPSec policy (name) explode: true style: form - in: query name: ipsec_policy_id schema: type: array items: type: integer description: IPSec policy (ID) explode: true style: form - in: query name: ipsec_policy_id__n schema: type: array items: type: integer description: IPSec policy (ID) 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: 87ac6ada0da14ccf 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: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__ie schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__iew schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__iregex schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__isw schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__n schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__nic schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__nie schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__niew schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__nisw schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf explode: true style: form - in: query name: mode__regex schema: type: array items: type: string x-spec-enum-id: 87ac6ada0da14ccf 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 - 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: q schema: type: string description: Search - 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 tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIPSecProfileList' description: '' post: operationId: vpn_ipsec_profiles_create description: Post a list of IPSec profile objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecProfileRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecProfileRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecProfileRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IPSecProfile' description: '' put: operationId: vpn_ipsec_profiles_bulk_update description: Put a list of IPSec profile objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProfile' description: '' patch: operationId: vpn_ipsec_profiles_bulk_partial_update description: Patch a list of IPSec profile objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProfile' description: '' delete: operationId: vpn_ipsec_profiles_bulk_destroy description: Delete a list of IPSec profile objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-profiles/{id}/: get: operationId: vpn_ipsec_profiles_retrieve description: Get a IPSec profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec profile. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProfile' description: '' put: operationId: vpn_ipsec_profiles_update description: Put a IPSec profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec profile. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPSecProfileRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIPSecProfileRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProfile' description: '' patch: operationId: vpn_ipsec_profiles_partial_update description: Patch a IPSec profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec profile. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPSecProfileRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIPSecProfileRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProfile' description: '' delete: operationId: vpn_ipsec_profiles_destroy description: Delete a IPSec profile object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec profile. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-proposals/: get: operationId: vpn_ipsec_proposals_list description: Get a list of IPSec proposal objects. parameters: - in: query name: authentication_algorithm schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication 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 title: Authentication explode: true style: form - in: query name: authentication_algorithm__ie schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__iew schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__iregex schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__isw schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__n schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__nic schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__nie schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__niew schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__nisw schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - in: query name: authentication_algorithm__regex schema: type: array items: type: string x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication explode: true style: form - 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: encryption_algorithm schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__empty schema: type: boolean - in: query name: encryption_algorithm__ic schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__ie schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__iew schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__iregex schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__isw schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__n schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__nic schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__nie schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__niew schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__nisw schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - in: query name: encryption_algorithm__regex schema: type: array items: type: string x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption explode: true style: form - 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: ipsec_policy schema: type: array items: type: string description: IPSec policy (name) explode: true style: form - in: query name: ipsec_policy__n schema: type: array items: type: string description: IPSec policy (name) explode: true style: form - in: query name: ipsec_policy_id schema: type: array items: type: integer description: IPSec policy (ID) explode: true style: form - in: query name: ipsec_policy_id__n schema: type: array items: type: integer description: IPSec policy (ID) 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: 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 - 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: q schema: type: string description: Search - in: query name: sa_lifetime_data schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_data__empty schema: type: boolean - in: query name: sa_lifetime_data__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_data__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_data__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_data__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_data__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds__empty schema: type: boolean - in: query name: sa_lifetime_seconds__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: sa_lifetime_seconds__n schema: type: array items: type: integer format: int32 explode: true style: form - 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 tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedIPSecProposalList' description: '' post: operationId: vpn_ipsec_proposals_create description: Post a list of IPSec proposal objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecProposalRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecProposalRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableIPSecProposalRequest' - type: array items: $ref: '#/components/schemas/WritableIPSecProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/IPSecProposal' description: '' put: operationId: vpn_ipsec_proposals_bulk_update description: Put a list of IPSec proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProposal' description: '' patch: operationId: vpn_ipsec_proposals_bulk_partial_update description: Patch a list of IPSec proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProposal' description: '' delete: operationId: vpn_ipsec_proposals_bulk_destroy description: Delete a list of IPSec proposal objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/IPSecProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/ipsec-proposals/{id}/: get: operationId: vpn_ipsec_proposals_retrieve description: Get a IPSec proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec proposal. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProposal' description: '' put: operationId: vpn_ipsec_proposals_update description: Put a IPSec proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec proposal. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableIPSecProposalRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableIPSecProposalRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProposal' description: '' patch: operationId: vpn_ipsec_proposals_partial_update description: Patch a IPSec proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec proposal. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableIPSecProposalRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableIPSecProposalRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/IPSecProposal' description: '' delete: operationId: vpn_ipsec_proposals_destroy description: Delete a IPSec proposal object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this IPSec proposal. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/l2vpn-terminations/: get: operationId: vpn_l2vpn_terminations_list description: Get a list of L2VPN termination objects. parameters: - in: query name: assigned_object_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__empty schema: type: boolean - in: query name: assigned_object_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: assigned_object_type schema: type: array items: type: string explode: true style: form - in: query name: assigned_object_type__n schema: type: array items: type: string explode: true style: form - in: query name: assigned_object_type_id schema: type: array items: type: integer explode: true style: form - in: query name: assigned_object_type_id__n schema: type: array items: type: integer explode: true style: form - 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: device schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device__n schema: type: array items: type: string nullable: true description: Device (name) explode: true style: form - in: query name: device_id schema: type: array items: type: integer description: Device (ID) explode: true style: form - in: query name: device_id__n schema: type: array items: type: integer description: Device (ID) explode: true style: form - 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: interface schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface__n schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: l2vpn schema: type: array items: type: string description: L2VPN (slug) explode: true style: form - in: query name: l2vpn__n schema: type: array items: type: string description: L2VPN (slug) explode: true style: form - in: query name: l2vpn_id schema: type: array items: type: integer description: L2VPN (ID) explode: true style: form - in: query name: l2vpn_id__n schema: type: array items: type: integer description: L2VPN (ID) 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: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: q schema: type: string description: Search - in: query name: region schema: type: array items: type: string explode: true style: form - in: query name: region_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: site schema: type: array items: type: string explode: true style: form - in: query name: site_id schema: type: array items: type: integer format: int32 explode: true style: form - 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: virtual_machine schema: type: array items: type: string description: Virtual machine (name) explode: true style: form - in: query name: virtual_machine__n schema: type: array items: type: string description: Virtual machine (name) explode: true style: form - in: query name: virtual_machine_id schema: type: array items: type: integer description: Virtual machine (ID) explode: true style: form - in: query name: virtual_machine_id__n schema: type: array items: type: integer description: Virtual machine (ID) explode: true style: form - in: query name: vlan schema: type: array items: type: string description: VLAN (name) explode: true style: form - in: query name: vlan__n schema: type: array items: type: string description: VLAN (name) explode: true style: form - in: query name: vlan_id schema: type: array items: type: integer description: VLAN (ID) explode: true style: form - in: query name: vlan_id__n schema: type: array items: type: integer description: VLAN (ID) explode: true style: form - in: query name: vlan_vid schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__empty schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__gt schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__gte schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__lt schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__lte schema: type: integer description: VLAN number (1-4094) - in: query name: vlan_vid__n schema: type: integer description: VLAN number (1-4094) - in: query name: vminterface schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface__n schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface_id schema: type: array items: type: integer description: VM Interface (ID) explode: true style: form - in: query name: vminterface_id__n schema: type: array items: type: integer description: VM Interface (ID) explode: true style: form tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedL2VPNTerminationList' description: '' post: operationId: vpn_l2vpn_terminations_create description: Post a list of L2VPN termination objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/L2VPNTerminationRequest' - type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/L2VPNTerminationRequest' - type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/L2VPNTermination' description: '' put: operationId: vpn_l2vpn_terminations_bulk_update description: Put a list of L2VPN termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNTermination' description: '' patch: operationId: vpn_l2vpn_terminations_bulk_partial_update description: Patch a list of L2VPN termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNTermination' description: '' delete: operationId: vpn_l2vpn_terminations_bulk_destroy description: Delete a list of L2VPN termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/l2vpn-terminations/{id}/: get: operationId: vpn_l2vpn_terminations_retrieve description: Get a L2VPN termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN termination. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPNTermination' description: '' put: operationId: vpn_l2vpn_terminations_update description: Put a L2VPN termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN termination. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/L2VPNTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/L2VPNTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPNTermination' description: '' patch: operationId: vpn_l2vpn_terminations_partial_update description: Patch a L2VPN termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN termination. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedL2VPNTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedL2VPNTerminationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPNTermination' description: '' delete: operationId: vpn_l2vpn_terminations_destroy description: Delete a L2VPN termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN termination. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/l2vpns/: get: operationId: vpn_l2vpns_list description: Get a list of L2VPN objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - 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: export_target schema: type: array items: type: string description: Export target (name) explode: true style: form - in: query name: export_target__n schema: type: array items: type: string description: Export target (name) explode: true style: form - in: query name: export_target_id schema: type: array items: type: integer description: Export target explode: true style: form - in: query name: export_target_id__n schema: type: array items: type: integer description: Export target explode: true style: form - 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: identifier schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__empty schema: type: boolean - in: query name: identifier__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: identifier__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: import_target schema: type: array items: type: string description: Import target (name) explode: true style: form - in: query name: import_target__n schema: type: array items: type: string description: Import target (name) explode: true style: form - in: query name: import_target_id schema: type: array items: type: integer description: Import target explode: true style: form - in: query name: import_target_id__n schema: type: array items: type: integer description: Import target 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: 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 - 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: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - in: query name: status schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 8b9dc8efc7c3d5b0 explode: true style: form - 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: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: type schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__empty schema: type: boolean - in: query name: type__ic schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__ie schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__iew schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__iregex schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__isw schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__n schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__nic schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__nie schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__niew schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__nisw schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: type__regex schema: type: array items: type: string x-spec-enum-id: 0a46f8056d717efc explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedL2VPNList' description: '' post: operationId: vpn_l2vpns_create description: Post a list of L2VPN objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableL2VPNRequest' - type: array items: $ref: '#/components/schemas/WritableL2VPNRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableL2VPNRequest' - type: array items: $ref: '#/components/schemas/WritableL2VPNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/L2VPN' description: '' put: operationId: vpn_l2vpns_bulk_update description: Put a list of L2VPN objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPN' description: '' patch: operationId: vpn_l2vpns_bulk_partial_update description: Patch a list of L2VPN objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPN' description: '' delete: operationId: vpn_l2vpns_bulk_destroy description: Delete a list of L2VPN objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/L2VPNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/l2vpns/{id}/: get: operationId: vpn_l2vpns_retrieve description: Get a L2VPN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPN' description: '' put: operationId: vpn_l2vpns_update description: Put a L2VPN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableL2VPNRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableL2VPNRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPN' description: '' patch: operationId: vpn_l2vpns_partial_update description: Patch a L2VPN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableL2VPNRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableL2VPNRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/L2VPN' description: '' delete: operationId: vpn_l2vpns_destroy description: Delete a L2VPN object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this L2VPN. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnel-groups/: get: operationId: vpn_tunnel_groups_list description: Get a list of tunnel group objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - 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: 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: 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: 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 - 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: q schema: type: string description: Search - in: query name: slug schema: type: array items: type: string explode: true style: form - in: query name: slug__empty schema: type: boolean - in: query name: slug__ic schema: type: array items: type: string explode: true style: form - in: query name: slug__ie schema: type: array items: type: string explode: true style: form - in: query name: slug__iew schema: type: array items: type: string explode: true style: form - in: query name: slug__iregex schema: type: array items: type: string explode: true style: form - in: query name: slug__isw schema: type: array items: type: string explode: true style: form - in: query name: slug__n schema: type: array items: type: string explode: true style: form - in: query name: slug__nic schema: type: array items: type: string explode: true style: form - in: query name: slug__nie schema: type: array items: type: string explode: true style: form - in: query name: slug__niew schema: type: array items: type: string explode: true style: form - in: query name: slug__nisw schema: type: array items: type: string explode: true style: form - in: query name: slug__regex schema: type: array items: type: string explode: true style: form - 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 tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTunnelGroupList' description: '' post: operationId: vpn_tunnel_groups_create description: Post a list of tunnel group objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/TunnelGroupRequest' - type: array items: $ref: '#/components/schemas/TunnelGroupRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/TunnelGroupRequest' - type: array items: $ref: '#/components/schemas/TunnelGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TunnelGroup' description: '' put: operationId: vpn_tunnel_groups_bulk_update description: Put a list of tunnel group objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelGroup' description: '' patch: operationId: vpn_tunnel_groups_bulk_partial_update description: Patch a list of tunnel group objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelGroup' description: '' delete: operationId: vpn_tunnel_groups_bulk_destroy description: Delete a list of tunnel group objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnel-groups/{id}/: get: operationId: vpn_tunnel_groups_retrieve description: Get a tunnel group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel group. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelGroup' description: '' put: operationId: vpn_tunnel_groups_update description: Put a tunnel group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel group. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/TunnelGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/TunnelGroupRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelGroup' description: '' patch: operationId: vpn_tunnel_groups_partial_update description: Patch a tunnel group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel group. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedTunnelGroupRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedTunnelGroupRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelGroup' description: '' delete: operationId: vpn_tunnel_groups_destroy description: Delete a tunnel group object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel group. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnel-terminations/: get: operationId: vpn_tunnel_terminations_list description: Get a list of tunnel termination objects. parameters: - 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: 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: interface schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface__n schema: type: array items: type: string description: Interface (name) explode: true style: form - in: query name: interface_id schema: type: array items: type: integer description: Interface (ID) explode: true style: form - in: query name: interface_id__n schema: type: array items: type: integer description: Interface (ID) 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: modified_by_request schema: type: string format: uuid - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - name: ordering required: false in: query description: Which field to use when ordering the results. schema: type: string - in: query name: outside_ip_id schema: type: array items: type: integer description: Outside IP (ID) explode: true style: form - in: query name: outside_ip_id__n schema: type: array items: type: integer description: Outside IP (ID) explode: true style: form - in: query name: q schema: type: string description: Search - in: query name: role schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__empty schema: type: boolean - in: query name: role__ic schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__ie schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__iew schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__iregex schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__isw schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__n schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nic schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nie schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__niew schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__nisw schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - in: query name: role__regex schema: type: array items: type: string x-spec-enum-id: 0b3bfadcebd86b58 explode: true style: form - 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: termination_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__empty schema: type: boolean - in: query name: termination_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: termination_type schema: type: array items: type: string explode: true style: form - in: query name: termination_type__n schema: type: array items: type: string explode: true style: form - in: query name: tunnel schema: type: array items: type: string description: Tunnel (name) explode: true style: form - in: query name: tunnel__n schema: type: array items: type: string description: Tunnel (name) explode: true style: form - in: query name: tunnel_id schema: type: array items: type: integer description: Tunnel (ID) explode: true style: form - in: query name: tunnel_id__n schema: type: array items: type: integer description: Tunnel (ID) explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid - in: query name: vminterface schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface__n schema: type: array items: type: string description: VM interface (name) explode: true style: form - in: query name: vminterface_id schema: type: array items: type: integer description: VM interface (ID) explode: true style: form - in: query name: vminterface_id__n schema: type: array items: type: integer description: VM interface (ID) explode: true style: form tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTunnelTerminationList' description: '' post: operationId: vpn_tunnel_terminations_create description: Post a list of tunnel termination objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableTunnelTerminationRequest' - type: array items: $ref: '#/components/schemas/WritableTunnelTerminationRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableTunnelTerminationRequest' - type: array items: $ref: '#/components/schemas/WritableTunnelTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/TunnelTermination' description: '' put: operationId: vpn_tunnel_terminations_bulk_update description: Put a list of tunnel termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelTermination' description: '' patch: operationId: vpn_tunnel_terminations_bulk_partial_update description: Patch a list of tunnel termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelTermination' description: '' delete: operationId: vpn_tunnel_terminations_bulk_destroy description: Delete a list of tunnel termination objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnel-terminations/{id}/: get: operationId: vpn_tunnel_terminations_retrieve description: Get a tunnel termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel termination. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelTermination' description: '' put: operationId: vpn_tunnel_terminations_update description: Put a tunnel termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel termination. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTunnelTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableTunnelTerminationRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelTermination' description: '' patch: operationId: vpn_tunnel_terminations_partial_update description: Patch a tunnel termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel termination. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableTunnelTerminationRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableTunnelTerminationRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/TunnelTermination' description: '' delete: operationId: vpn_tunnel_terminations_destroy description: Delete a tunnel termination object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel termination. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnels/: get: operationId: vpn_tunnels_list description: Get a list of tunnel objects. parameters: - in: query name: contact schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact__n schema: type: array items: type: integer description: Contact explode: true style: form - in: query name: contact_group schema: type: array items: type: string explode: true style: form - in: query name: contact_group__n schema: type: array items: type: string explode: true style: form - in: query name: contact_role schema: type: array items: type: integer description: Contact Role explode: true style: form - in: query name: contact_role__n schema: type: array items: type: integer description: Contact Role explode: true style: form - 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: encapsulation schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__empty schema: type: boolean - in: query name: encapsulation__ic schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__ie schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__iew schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__iregex schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__isw schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__n schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__nic schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__nie schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__niew schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__nisw schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: encapsulation__regex schema: type: array items: type: string x-spec-enum-id: 4f3254459f0e94f0 explode: true style: form - in: query name: group schema: type: array items: type: string description: Tunnel group (slug) explode: true style: form - in: query name: group__n schema: type: array items: type: string description: Tunnel group (slug) explode: true style: form - in: query name: group_id schema: type: array items: type: integer nullable: true description: Tunnel group (ID) explode: true style: form - in: query name: group_id__n schema: type: array items: type: integer nullable: true description: Tunnel group (ID) explode: true style: form - 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: ipsec_profile schema: type: array items: type: string description: IPSec profile (name) explode: true style: form - in: query name: ipsec_profile__n schema: type: array items: type: string description: IPSec profile (name) explode: true style: form - in: query name: ipsec_profile_id schema: type: array items: type: integer nullable: true description: IPSec profile (ID) explode: true style: form - in: query name: ipsec_profile_id__n schema: type: array items: type: integer nullable: true description: IPSec profile (ID) 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: 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 - 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: q schema: type: string description: Search - in: query name: status schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__empty schema: type: boolean - in: query name: status__ic schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__ie schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__iew schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__iregex schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__isw schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__n schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__nic schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__nie schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__niew schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__nisw schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - in: query name: status__regex schema: type: array items: type: string x-spec-enum-id: 2431ef62c418f485 explode: true style: form - 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: tenant schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant__n schema: type: array items: type: string description: Tenant (slug) explode: true style: form - in: query name: tenant_group schema: type: array items: type: string explode: true style: form - in: query name: tenant_group__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id schema: type: array items: type: string explode: true style: form - in: query name: tenant_group_id__n schema: type: array items: type: string explode: true style: form - in: query name: tenant_id schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tenant_id__n schema: type: array items: type: integer nullable: true description: Tenant (ID) explode: true style: form - in: query name: tunnel_id schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tunnel_id__empty schema: type: boolean - in: query name: tunnel_id__gt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tunnel_id__gte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tunnel_id__lt schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tunnel_id__lte schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: tunnel_id__n schema: type: array items: type: integer format: int32 explode: true style: form - in: query name: updated_by_request schema: type: string format: uuid tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTunnelList' description: '' post: operationId: vpn_tunnels_create description: Post a list of tunnel objects. tags: - vpn requestBody: content: application/json: schema: oneOf: - $ref: '#/components/schemas/WritableTunnelRequest' - type: array items: $ref: '#/components/schemas/WritableTunnelRequest' multipart/form-data: schema: oneOf: - $ref: '#/components/schemas/WritableTunnelRequest' - type: array items: $ref: '#/components/schemas/WritableTunnelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Tunnel' description: '' put: operationId: vpn_tunnels_bulk_update description: Put a list of tunnel objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Tunnel' description: '' patch: operationId: vpn_tunnels_bulk_partial_update description: Patch a list of tunnel objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Tunnel' description: '' delete: operationId: vpn_tunnels_bulk_destroy description: Delete a list of tunnel objects. tags: - vpn requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' multipart/form-data: schema: type: array items: $ref: '#/components/schemas/TunnelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body /api/vpn/tunnels/{id}/: get: operationId: vpn_tunnels_retrieve description: Get a tunnel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Tunnel' description: '' put: operationId: vpn_tunnels_update description: Put a tunnel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/WritableTunnelRequest' multipart/form-data: schema: $ref: '#/components/schemas/WritableTunnelRequest' required: true security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Tunnel' description: '' patch: operationId: vpn_tunnels_partial_update description: Patch a tunnel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel. required: true tags: - vpn requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedWritableTunnelRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedWritableTunnelRequest' security: - cookieAuth: [] - tokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Tunnel' description: '' delete: operationId: vpn_tunnels_destroy description: Delete a tunnel object. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this tunnel. required: true tags: - vpn security: - cookieAuth: [] - tokenAuth: [] responses: '204': description: No response body components: schemas: PaginatedL2VPNTerminationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/L2VPNTermination' BriefIPSecPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name L2VPNTermination: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true l2vpn: $ref: '#/components/schemas/BriefL2VPN' assigned_object_type: type: string assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 assigned_object: readOnly: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - assigned_object - assigned_object_id - assigned_object_type - created - display - display_url - id - l2vpn - last_updated - url BriefIKEPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name PatchedL2VPNTerminationRequest: type: object description: Adds support for custom fields and tags. properties: l2vpn: oneOf: - type: integer - $ref: '#/components/schemas/BriefL2VPNRequest' assigned_object_type: type: string assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefIPSecProfile: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url BriefTunnelGroup: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 tunnel_count: type: integer format: int64 readOnly: true required: - display - id - name - slug - tunnel_count - url BriefTunnel: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url PaginatedIPSecProfileList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IPSecProfile' BriefIPAddressRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: address: type: string minLength: 1 description: type: string maxLength: 200 required: - address PatchedWritableIPSecPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 proposals: type: array items: type: integer pfs_group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - null type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: 'Diffie-Hellman group for Perfect Forward Secrecy * `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' minimum: 0 maximum: 32767 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefL2VPNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc description: type: string maxLength: 200 required: - name - slug WritableIPSecProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 mode: enum: - esp - ah type: string description: '* `esp` - ESP * `ah` - AH' x-spec-enum-id: 87ac6ada0da14ccf ike_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIKEPolicyRequest' ipsec_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIPSecPolicyRequest' owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - ike_policy - ipsec_policy - mode - name PaginatedTunnelList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Tunnel' PatchedWritableTunnelTerminationRequest: type: object description: Adds support for custom fields and tags. properties: tunnel: oneOf: - type: integer - $ref: '#/components/schemas/BriefTunnelRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 termination_type: type: string termination_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true outside_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} IKEProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 authentication_method: enum: - preshared-keys - certificates - rsa-signatures - dsa-signatures type: string description: '* `preshared-keys` - Pre-shared keys * `certificates` - Certificates * `rsa-signatures` - RSA signatures * `dsa-signatures` - DSA signatures' x-spec-enum-id: a21158c52d0c455a encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer description: '* `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' x-spec-enum-id: dbef43be795462a8 sa_lifetime: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Security association lifetime (in seconds) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - authentication_method - encryption_algorithm - group - name PatchedWritableIPSecProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 mode: enum: - esp - ah type: string description: '* `esp` - ESP * `ah` - AH' x-spec-enum-id: 87ac6ada0da14ccf ike_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIKEPolicyRequest' ipsec_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIPSecPolicyRequest' owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} IPSecProposal: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 encryption_algorithm: type: object properties: value: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 label: type: string enum: - 128-bit AES (CBC) - 128-bit AES (GCM) - 192-bit AES (CBC) - 192-bit AES (GCM) - 256-bit AES (CBC) - 256-bit AES (GCM) - 3DES - DES authentication_algorithm: type: object properties: value: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 label: type: string enum: - SHA-1 HMAC - SHA-256 HMAC - SHA-384 HMAC - SHA-512 HMAC - MD5 HMAC sa_lifetime_seconds: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (seconds) description: Security association lifetime (seconds) sa_lifetime_data: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (KB) description: Security association lifetime (in kilobytes) owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url PaginatedTunnelTerminationList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/TunnelTermination' L2VPNTerminationRequest: type: object description: Adds support for custom fields and tags. properties: l2vpn: oneOf: - type: integer - $ref: '#/components/schemas/BriefL2VPNRequest' assigned_object_type: type: string assigned_object_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - assigned_object_id - assigned_object_type - l2vpn TunnelTermination: type: object description: Adds support for custom fields and tags. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true tunnel: $ref: '#/components/schemas/BriefTunnel' role: type: object properties: value: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 label: type: string enum: - Peer - Hub - Spoke termination_type: type: string termination_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true termination: readOnly: true nullable: true outside_ip: allOf: - $ref: '#/components/schemas/BriefIPAddress' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - role - termination - termination_type - tunnel - url PatchedWritableL2VPNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc status: enum: - active - planned - decommissioning type: string description: '* `active` - Active * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 8b9dc8efc7c3d5b0 import_targets: type: array items: type: integer export_targets: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefTenantRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug BriefIKEPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url PaginatedTunnelGroupList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/TunnelGroup' L2VPN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: type: object properties: value: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc label: type: string enum: - VPWS - VPLS - VXLAN - VXLAN-EVPN - MPLS EVPN - PBB EVPN - EVPN VPWS - EPL - EVPL - Ethernet Private LAN - Ethernet Virtual Private LAN - Ethernet Private Tree - Ethernet Virtual Private Tree - SPB status: type: object properties: value: enum: - active - planned - decommissioning type: string description: '* `active` - Active * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 8b9dc8efc7c3d5b0 label: type: string enum: - Active - Planned - Decommissioning import_targets: type: array items: $ref: '#/components/schemas/RouteTarget' export_targets: type: array items: $ref: '#/components/schemas/RouteTarget' description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - slug - url RouteTarget: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string description: Route target value (formatted in accordance with RFC 4360) maxLength: 21 tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url IPSecProfile: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 mode: type: object properties: value: enum: - esp - ah type: string description: '* `esp` - ESP * `ah` - AH' x-spec-enum-id: 87ac6ada0da14ccf label: type: string enum: - ESP - AH ike_policy: $ref: '#/components/schemas/BriefIKEPolicy' ipsec_policy: $ref: '#/components/schemas/BriefIPSecPolicy' owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - ike_policy - ipsec_policy - last_updated - mode - name - url BriefIPAddress: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true family: type: object properties: value: enum: - 4 - 6 type: integer description: '* `4` - IPv4 * `6` - IPv6' x-spec-enum-id: d72003fd1af3603d label: type: string enum: - IPv4 - IPv6 readOnly: true address: type: string description: type: string maxLength: 200 required: - address - display - family - id - url PatchedWritableTunnelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 status: enum: - planned - active - disabled type: string description: '* `planned` - Planned * `active` - Active * `disabled` - Disabled' x-spec-enum-id: 2431ef62c418f485 group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTunnelGroupRequest' nullable: true nullable: true encapsulation: enum: - ipsec-transport - ipsec-tunnel - ip-ip - gre - wireguard - openvpn - l2tp - pptp type: string description: '* `ipsec-transport` - IPsec - Transport * `ipsec-tunnel` - IPsec - Tunnel * `ip-ip` - IP-in-IP * `gre` - GRE * `wireguard` - WireGuard * `openvpn` - OpenVPN * `l2tp` - L2TP * `pptp` - PPTP' x-spec-enum-id: 4f3254459f0e94f0 ipsec_profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPSecProfileRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tunnel_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefTunnelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name Tunnel: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 status: type: object properties: value: enum: - planned - active - disabled type: string description: '* `planned` - Planned * `active` - Active * `disabled` - Disabled' x-spec-enum-id: 2431ef62c418f485 label: type: string enum: - Planned - Active - Disabled group: allOf: - $ref: '#/components/schemas/BriefTunnelGroup' nullable: true encapsulation: type: object properties: value: enum: - ipsec-transport - ipsec-tunnel - ip-ip - gre - wireguard - openvpn - l2tp - pptp type: string description: '* `ipsec-transport` - IPsec - Transport * `ipsec-tunnel` - IPsec - Tunnel * `ip-ip` - IP-in-IP * `gre` - GRE * `wireguard` - WireGuard * `openvpn` - OpenVPN * `l2tp` - L2TP * `pptp` - PPTP' x-spec-enum-id: 4f3254459f0e94f0 label: type: string enum: - IPsec - Transport - IPsec - Tunnel - IP-in-IP - GRE - WireGuard - OpenVPN - L2TP - PPTP ipsec_profile: allOf: - $ref: '#/components/schemas/BriefIPSecProfile' nullable: true tenant: allOf: - $ref: '#/components/schemas/BriefTenant' nullable: true tunnel_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true terminations_count: type: integer format: int64 readOnly: true required: - created - display - display_url - encapsulation - id - last_updated - name - status - terminations_count - url PatchedWritableIPSecProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc - '' - null type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 - '' - null type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication sa_lifetime_seconds: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (seconds) description: Security association lifetime (seconds) sa_lifetime_data: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (KB) description: Security association lifetime (in kilobytes) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} IPSecProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 mode: enum: - esp - ah type: string description: '* `esp` - ESP * `ah` - AH' x-spec-enum-id: 87ac6ada0da14ccf ike_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIKEPolicyRequest' ipsec_policy: oneOf: - type: integer - $ref: '#/components/schemas/BriefIPSecPolicyRequest' owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - ike_policy - ipsec_policy - mode - name NestedTag: type: object description: '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 uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string pattern: ^[-\w]+$ maxLength: 100 color: type: string pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - display - display_url - id - name - slug - url BriefL2VPN: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: type: object properties: value: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc label: type: string enum: - VPWS - VPLS - VXLAN - VXLAN-EVPN - MPLS EVPN - PBB EVPN - EVPN VPWS - EPL - EVPL - Ethernet Private LAN - Ethernet Virtual Private LAN - Ethernet Private Tree - Ethernet Virtual Private Tree - SPB description: type: string maxLength: 200 required: - display - id - name - slug - url PaginatedL2VPNList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/L2VPN' BriefTenant: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - display - id - name - slug - url PatchedTunnelGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} BriefOwnerRequest: type: object description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name WritableTunnelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 status: enum: - planned - active - disabled type: string description: '* `planned` - Planned * `active` - Active * `disabled` - Disabled' x-spec-enum-id: 2431ef62c418f485 group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTunnelGroupRequest' nullable: true nullable: true encapsulation: enum: - ipsec-transport - ipsec-tunnel - ip-ip - gre - wireguard - openvpn - l2tp - pptp type: string description: '* `ipsec-transport` - IPsec - Transport * `ipsec-tunnel` - IPsec - Tunnel * `ip-ip` - IP-in-IP * `gre` - GRE * `wireguard` - WireGuard * `openvpn` - OpenVPN * `l2tp` - L2TP * `pptp` - PPTP' x-spec-enum-id: 4f3254459f0e94f0 ipsec_profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPSecProfileRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tunnel_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - encapsulation - name IPSecPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 proposals: type: array items: $ref: '#/components/schemas/IPSecProposal' pfs_group: type: object properties: value: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer description: '* `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' x-spec-enum-id: dbef43be795462a8 label: type: string enum: - Group 1 - Group 2 - Group 5 - Group 14 - Group 15 - Group 16 - Group 17 - Group 18 - Group 19 - Group 20 - Group 21 - Group 22 - Group 23 - Group 24 - Group 25 - Group 26 - Group 27 - Group 28 - Group 29 - Group 30 - Group 31 - Group 32 - Group 33 - Group 34 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url BriefTunnelGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 required: - name - slug TunnelTerminationRequest: type: object description: Adds support for custom fields and tags. properties: tunnel: oneOf: - type: integer - $ref: '#/components/schemas/BriefTunnelRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 termination_type: type: string termination_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true outside_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - role - termination_type - tunnel IPSecProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 sa_lifetime_seconds: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (seconds) description: Security association lifetime (seconds) sa_lifetime_data: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (KB) description: Security association lifetime (in kilobytes) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name WritableL2VPNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc status: enum: - active - planned - decommissioning type: string description: '* `active` - Active * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 8b9dc8efc7c3d5b0 import_targets: type: array items: type: integer export_targets: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug - type WritableTunnelTerminationRequest: type: object description: Adds support for custom fields and tags. properties: tunnel: oneOf: - type: integer - $ref: '#/components/schemas/BriefTunnelRequest' role: enum: - peer - hub - spoke type: string description: '* `peer` - Peer * `hub` - Hub * `spoke` - Spoke' x-spec-enum-id: 0b3bfadcebd86b58 termination_type: type: string termination_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true outside_ip: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPAddressRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - termination_type - tunnel IKEProposal: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 authentication_method: type: object properties: value: enum: - preshared-keys - certificates - rsa-signatures - dsa-signatures type: string description: '* `preshared-keys` - Pre-shared keys * `certificates` - Certificates * `rsa-signatures` - RSA signatures * `dsa-signatures` - DSA signatures' x-spec-enum-id: a21158c52d0c455a label: type: string enum: - Pre-shared keys - Certificates - RSA signatures - DSA signatures encryption_algorithm: type: object properties: value: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 label: type: string enum: - 128-bit AES (CBC) - 128-bit AES (GCM) - 192-bit AES (CBC) - 192-bit AES (GCM) - 256-bit AES (CBC) - 256-bit AES (GCM) - 3DES - DES authentication_algorithm: type: object properties: value: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 label: type: string enum: - SHA-1 HMAC - SHA-256 HMAC - SHA-384 HMAC - SHA-512 HMAC - MD5 HMAC group: type: object properties: value: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer description: '* `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' x-spec-enum-id: dbef43be795462a8 label: type: string enum: - Group 1 - Group 2 - Group 5 - Group 14 - Group 15 - Group 16 - Group 17 - Group 18 - Group 19 - Group 20 - Group 21 - Group 22 - Group 23 - Group 24 - Group 25 - Group 26 - Group 27 - Group 28 - Group 29 - Group 30 - Group 31 - Group 32 - Group 33 - Group 34 sa_lifetime: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Security association lifetime (in seconds) owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - authentication_method - created - display - display_url - encryption_algorithm - group - id - last_updated - name - url IKEPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 version: type: object properties: value: enum: - 1 - 2 type: integer description: '* `1` - IKEv1 * `2` - IKEv2' x-spec-enum-id: 00872b77916a1fde label: type: string enum: - IKEv1 - IKEv2 mode: type: object properties: value: enum: - aggressive - main type: string description: '* `aggressive` - Aggressive * `main` - Main' x-spec-enum-id: 64c1be7bdb2548ca label: type: string enum: - Aggressive - Main proposals: type: array items: $ref: '#/components/schemas/IKEProposal' preshared_key: type: string title: Pre-shared key owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true required: - created - display - display_url - id - last_updated - name - url - version PatchedWritableIKEProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 authentication_method: enum: - preshared-keys - certificates - rsa-signatures - dsa-signatures type: string description: '* `preshared-keys` - Pre-shared keys * `certificates` - Certificates * `rsa-signatures` - RSA signatures * `dsa-signatures` - DSA signatures' x-spec-enum-id: a21158c52d0c455a encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 - '' - null type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 nullable: true group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer x-spec-enum-id: dbef43be795462a8 description: 'Diffie-Hellman group ID * `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' minimum: 0 maximum: 32767 sa_lifetime: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Security association lifetime (in seconds) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedIKEPolicyList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IKEPolicy' TunnelGroupRequest: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug PatchedWritableIKEPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 version: enum: - 1 - 2 type: integer description: '* `1` - IKEv1 * `2` - IKEv2' x-spec-enum-id: 00872b77916a1fde minimum: 0 maximum: 32767 mode: enum: - aggressive - main - '' - null type: string description: '* `aggressive` - Aggressive * `main` - Main' x-spec-enum-id: 64c1be7bdb2548ca nullable: true proposals: type: array items: type: integer preshared_key: type: string title: Pre-shared key owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} PaginatedIPSecProposalList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IPSecProposal' WritableIPSecProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc - '' - null type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 nullable: true title: Encryption authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 - '' - null type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 nullable: true title: Authentication sa_lifetime_seconds: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (seconds) description: Security association lifetime (seconds) sa_lifetime_data: type: integer maximum: 2147483647 minimum: 0 nullable: true title: SA lifetime (KB) description: Security association lifetime (in kilobytes) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name BriefOwner: type: object description: 'Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)' properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url PaginatedIKEProposalList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IKEProposal' WritableIPSecPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 proposals: type: array items: type: integer pfs_group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - null type: integer x-spec-enum-id: dbef43be795462a8 nullable: true description: 'Diffie-Hellman group for Perfect Forward Secrecy * `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' minimum: 0 maximum: 32767 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name L2VPNRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: identifier: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 nullable: true name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ type: enum: - vpws - vpls - vxlan - vxlan-evpn - mpls-evpn - pbb-evpn - evpn-vpws - epl - evpl - ep-lan - evp-lan - ep-tree - evp-tree - spb type: string description: '* `vpws` - VPWS * `vpls` - VPLS * `vxlan` - VXLAN * `vxlan-evpn` - VXLAN-EVPN * `mpls-evpn` - MPLS EVPN * `pbb-evpn` - PBB EVPN * `evpn-vpws` - EVPN VPWS * `epl` - EPL * `evpl` - EVPL * `ep-lan` - Ethernet Private LAN * `evp-lan` - Ethernet Virtual Private LAN * `ep-tree` - Ethernet Private Tree * `evp-tree` - Ethernet Virtual Private Tree * `spb` - SPB' x-spec-enum-id: 0a46f8056d717efc status: enum: - active - planned - decommissioning type: string description: '* `active` - Active * `planned` - Planned * `decommissioning` - Decommissioning' x-spec-enum-id: 8b9dc8efc7c3d5b0 import_targets: type: array items: type: integer export_targets: type: array items: type: integer description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - slug BriefIPSecProfileRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 required: - name BriefIPSecPolicy: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 description: type: string maxLength: 200 required: - display - id - name - url PaginatedIPSecPolicyList: type: object required: - count - results properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/IPSecPolicy' IPSecPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 proposals: type: array items: type: integer pfs_group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer description: '* `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' x-spec-enum-id: dbef43be795462a8 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name IKEPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 version: enum: - 1 - 2 type: integer description: '* `1` - IKEv1 * `2` - IKEv2' x-spec-enum-id: 00872b77916a1fde mode: enum: - aggressive - main type: string description: '* `aggressive` - Aggressive * `main` - Main' x-spec-enum-id: 64c1be7bdb2548ca proposals: type: array items: type: integer preshared_key: type: string title: Pre-shared key owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name - version TunnelRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 status: enum: - planned - active - disabled type: string description: '* `planned` - Planned * `active` - Active * `disabled` - Disabled' x-spec-enum-id: 2431ef62c418f485 group: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTunnelGroupRequest' nullable: true nullable: true encapsulation: enum: - ipsec-transport - ipsec-tunnel - ip-ip - gre - wireguard - openvpn - l2tp - pptp type: string description: '* `ipsec-transport` - IPsec - Transport * `ipsec-tunnel` - IPsec - Tunnel * `ip-ip` - IP-in-IP * `gre` - GRE * `wireguard` - WireGuard * `openvpn` - OpenVPN * `l2tp` - L2TP * `pptp` - PPTP' x-spec-enum-id: 4f3254459f0e94f0 ipsec_profile: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefIPSecProfileRequest' nullable: true nullable: true tenant: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefTenantRequest' nullable: true nullable: true tunnel_id: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 nullable: true description: type: string maxLength: 200 owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - encapsulation - name - status WritableIKEProposalRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 authentication_method: enum: - preshared-keys - certificates - rsa-signatures - dsa-signatures type: string description: '* `preshared-keys` - Pre-shared keys * `certificates` - Certificates * `rsa-signatures` - RSA signatures * `dsa-signatures` - DSA signatures' x-spec-enum-id: a21158c52d0c455a encryption_algorithm: enum: - aes-128-cbc - aes-128-gcm - aes-192-cbc - aes-192-gcm - aes-256-cbc - aes-256-gcm - 3des-cbc - des-cbc type: string description: '* `aes-128-cbc` - 128-bit AES (CBC) * `aes-128-gcm` - 128-bit AES (GCM) * `aes-192-cbc` - 192-bit AES (CBC) * `aes-192-gcm` - 192-bit AES (GCM) * `aes-256-cbc` - 256-bit AES (CBC) * `aes-256-gcm` - 256-bit AES (GCM) * `3des-cbc` - 3DES * `des-cbc` - DES' x-spec-enum-id: ae3dabd7b2b3cba2 authentication_algorithm: enum: - hmac-sha1 - hmac-sha256 - hmac-sha384 - hmac-sha512 - hmac-md5 - '' - null type: string description: '* `hmac-sha1` - SHA-1 HMAC * `hmac-sha256` - SHA-256 HMAC * `hmac-sha384` - SHA-384 HMAC * `hmac-sha512` - SHA-512 HMAC * `hmac-md5` - MD5 HMAC' x-spec-enum-id: 0a7ca69695b483a7 nullable: true group: enum: - 1 - 2 - 5 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 type: integer x-spec-enum-id: dbef43be795462a8 description: 'Diffie-Hellman group ID * `1` - Group 1 * `2` - Group 2 * `5` - Group 5 * `14` - Group 14 * `15` - Group 15 * `16` - Group 16 * `17` - Group 17 * `18` - Group 18 * `19` - Group 19 * `20` - Group 20 * `21` - Group 21 * `22` - Group 22 * `23` - Group 23 * `24` - Group 24 * `25` - Group 25 * `26` - Group 26 * `27` - Group 27 * `28` - Group 28 * `29` - Group 29 * `30` - Group 30 * `31` - Group 31 * `32` - Group 32 * `33` - Group 33 * `34` - Group 34' minimum: 0 maximum: 32767 sa_lifetime: type: integer maximum: 2147483647 minimum: 0 nullable: true description: Security association lifetime (in seconds) owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - authentication_method - encryption_algorithm - group - name WritableIKEPolicyRequest: type: object description: Base serializer class for models inheriting from PrimaryModel. properties: name: type: string minLength: 1 maxLength: 100 description: type: string maxLength: 200 version: enum: - 1 - 2 type: integer description: '* `1` - IKEv1 * `2` - IKEv2' x-spec-enum-id: 00872b77916a1fde minimum: 0 maximum: 32767 mode: enum: - aggressive - main - '' - null type: string description: '* `aggressive` - Aggressive * `main` - Main' x-spec-enum-id: 64c1be7bdb2548ca nullable: true proposals: type: array items: type: integer preshared_key: type: string title: Pre-shared key owner: oneOf: - type: integer - allOf: - $ref: '#/components/schemas/BriefOwnerRequest' nullable: true nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTagRequest' custom_fields: type: object additionalProperties: {} required: - name NestedTagRequest: type: object description: '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 uniquely identify the related object. This class should be subclassed to return a full representation of the related object on read.' properties: name: type: string minLength: 1 maxLength: 100 slug: type: string minLength: 1 pattern: ^[-\w]+$ maxLength: 100 color: type: string minLength: 1 pattern: ^[0-9a-f]{6}$ maxLength: 6 required: - name - slug TunnelGroup: type: object description: Base serializer class for models inheriting from OrganizationalModel. properties: id: type: integer readOnly: true url: type: string format: uri readOnly: true display_url: type: string format: uri readOnly: true display: type: string readOnly: true name: type: string maxLength: 100 slug: type: string maxLength: 100 pattern: ^[-a-zA-Z0-9_]+$ description: type: string maxLength: 200 owner: allOf: - $ref: '#/components/schemas/BriefOwner' nullable: true comments: type: string tags: type: array items: $ref: '#/components/schemas/NestedTag' custom_fields: type: object additionalProperties: {} created: type: string format: date-time readOnly: true nullable: true last_updated: type: string format: date-time readOnly: true nullable: true tunnel_count: type: integer format: int64 readOnly: true required: - created - display - display_url - id - last_updated - name - slug - tunnel_count - url securitySchemes: cookieAuth: type: apiKey in: cookie name: sessionid tokenAuth: type: apiKey in: header name: Authorization description: '`Token ` (v1) or `Bearer .` (v2)'