Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

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

Folders let you group server entries into a tree-structured sidebar. You can nest folders inside other folders using parentId, and assign folders to an organization to share them across team members. All endpoints require authentication via Authorization: Bearer YOUR_TOKEN.

​
GET /api/folder/list

Returns all folders belonging to the authenticated user, including folders shared through organizations.

​
Response

Returns an array of folder objects.
​
[].id
number
Unique folder identifier.
​
[].name
string
Display name of the folder.
​
[].parentId
number
ID of the parent folder, or null if this is a top-level folder.
​
[].organizationId
number
ID of the organization this folder belongs to, or null for personal folders.
curl --request GET \
  --url http://your-server:6989/api/folder/list \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
PUT /api/folder

Creates a new folder.

​
Request body

​
name
string
required
Display name for the folder. Between 3 and 50 characters.
​
parentId
number
ID of the parent folder. Omit or pass null to create a top-level folder.
​
organizationId
number
ID of the organization to assign this folder to. Omit or pass null for a personal folder.

​
Response

​
id
number
ID of the newly created folder.
​
message
string
Confirmation message.
curl --request PUT \
  --url http://your-server:6989/api/folder \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Production Servers"}'

​
PATCH /api/folder/:folderId

Updates an existing folder. At least one field must be provided.

​
Path parameters

​
folderId
string
required
Unique identifier of the folder to update.

​
Request body

At least one of the following fields is required.
​
name
string
New display name. Between 3 and 50 characters.
​
parentId
number
Move the folder to a different parent. Pass null to promote to the top level.
​
organizationId
number
Reassign to a different organization, or null to make personal.

​
Response

​
message
string
Confirmation message.
curl --request PATCH \
  --url http://your-server:6989/api/folder/5 \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Staging Servers"}'

​
DELETE /api/folder/:folderId

Permanently deletes a folder. Any entries inside the folder may be moved to a default location.
Folder deletion is permanent and cannot be undone.

​
Path parameters

​
folderId
string
required
Unique identifier of the folder to delete.

​
Response

​
message
string
Confirmation message.
curl --request DELETE \
  --url http://your-server:6989/api/folder/5 \
  --header 'Authorization: Bearer YOUR_TOKEN'

Build docs developers (and LLMs) love

Get started for freeTalk to us