Documentation Index

Fetch the complete documentation index at: https://support.perimeter81.com/llms.txt

Use this file to discover all available pages before exploring further.

Important Notice: This Perimeter 81 documentation site is being deprecated and will be permanently removed on July 26, 2026.

Please use the latest Check Point Documentation Portal for current product documentation and updates. Access the Check Point Documentation Portal

Schemas

Prev Next

Request Headers

Each request must include the following request headers:

PropertyData TypeDescription
Authorization*StringYour temporary Access Token obtained using the /authorize method
Content-Type*
String
application/json

Request Body Schemas

Groups

Groups contain applications, networks, locations, and members (users) that have access to resources.

CreateGroupDto

DTO for creating a group. Request body in POST /v1/groups.

Property

Data Type

Description

name

String

Name of the group.

description

String

Description of group.

Group

Data for a single group. Response to POST /v1/groups, DELETE /v1/groups/{id}, POST /v1/groups/{groupId}/member/{userId}, and DELETE /v1/groups/{groupId}/member/{userId}. Found in GroupList.

PropertyData TypeDescription
name*StringName of the group.
isDefault*BooleanWhether the group is a default group (true).
applications*Array of StringList of group applications.
networks*Array of StringList of group networks.
vpnLocations*Array of StringList of group locations.
users*Array of StringList of group members.
id*StringGroup ID.

GroupList

List of Group. Response to GET /v1/groups.

PropertyData TypeDescription
data*Array of GroupList of groups.
page*NumberPage number.
totalPage*NumberNumber of pages in list.
itemsTotal*NumberNumber of items in list.