New Group (POST)
  • 01 Aug 2023
  • 1 Minute to read
  • Contributors

    New Group (POST)


      Article Summary

      POST /v1/groups

      Create an access group that holds applications, networks, VPN locations, and users.

      Parameters: None

      Request Body: CreateGroupDto

      Request Example:

      curl -X POST -H 'Authorization: Bearer <ACCESS_TOKEN>' -H 'Content-Type: application/json' \
      -d '{ 
      	"name": "<NAME>", 
      	"description": "<DESCRIPTION>" 
      }' 'https://api.perimeter81.com/api/rest/v1/groups' 

      Response Body:

      Status Code

      Message/Response Body

      Description

      201

      Group Schema

      Success. The resource was created.

      400


      Bad request.

      401

      Unauthorized

      Wrong or expired Access Token

      Response Example (201):

      {
        "tenantId":"<TENANT_ID>",
        "name":"<GROUP_NAME>",
        "description":"<GROUP_DESCRIPTION>",
        "isDefault":false,
        "applications":[],
        "networks":[],
        "vpnLocations":[],
        "users":[],
        "createdAt":"2021-09-29T16:45:48.968Z",
        "updatedAt":"2021-09-29T16:45:48.969Z",
        "id":"zyKN1cBLpc"
      }

      Was this article helpful?