Validate a plugin local folder
POST
/api/plugins/{pluginId}/companies/{companyId}/local-folders/{folderKey}/validatePersonal API keyConsole session
Validate a plugin local folder.
Authorization
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. How keys work.
Path parameters
pluginIdstringRequiredThe plugin's id.
companyIdstringRequiredThe organization's id.
folderKeystringRequiredThe folderkey's id.
Request body
application/json · required
pathstringRequired
at least 1 characteraccessstringOptional
one of: "read", "readWrite"requiredDirectoriesarray<string>Optional
requiredFilesarray<string>Optional
Responses
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Errors return {"error": "..."}, often with a code and details. See errors and limits.