frappe-impl-whitelisted

Implement secure Frappe API endpoints with whitelisted methods and permission checks.

163|53|Updated Jan 14, 2026
One-click install
npx skills add https://github.com/OpenAEC-Foundation/Frappe_Claude_Skill_Package --skill frappe-impl-whitelisted
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: frappe-impl-whitelisted
Source: https://github.com/OpenAEC-Foundation/Frappe_Claude_Skill_Package/tree/main/skills/source/impl/frappe-impl-whitelisted
Command: npx skills add https://github.com/OpenAEC-Foundation/Frappe_Claude_Skill_Package --skill frappe-impl-whitelisted

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Use when building API endpoints with @frappe.whitelist() in Frappe. Covers endpoint design, permission patterns, error handling, client integration, file uploads, background jobs, rate limiting, REST API testing, and migration from Server Scripts to whitelisted methods. Prevents permission bypasses, SQL injection, and data exposure.

Core Features & Use Cases

  • Endpoint design patterns, permission models, error handling, client integration, file uploads, background jobs, rate limiting, REST API testing, and migration from Server Scripts to whitelisted methods.
  • Prevents permission bypasses, SQL injection, and data exposure.

Quick Start

Begin by creating a whitelisted API method using @frappe.whitelist() and apply the documented patterns for permission checks, validation, and safe responses.

Frequently Asked Questions about frappe-impl-whitelisted

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create secure API endpoints in Frappe using whitelisted methods?

To create secure API endpoints in Frappe, use the @frappe.whitelist() decorator and apply documented patterns for permission checks, input validation, and safe responses. This approach prevents permission bypasses, SQL injection, and data exposure.

How do I migrate from Server Script APIs to whitelisted methods in Frappe?

Migrating from Server Script APIs to whitelisted methods involves transitioning your endpoint logic to Python methods decorated with @frappe.whitelist(). This provides robust error handling and parameterized access while eliminating Server Script security risks.

Does Frappe whitelist support rate limiting and file uploads for guest APIs?

Yes, Frappe whitelisted methods support public guest APIs, file uploads, and background jobs. The implementation includes guidance for rate limiting and endpoint design patterns to ensure secure client integration.

What is the best way to handle permissions and validation for Frappe API design?

The best way to handle Frappe API permissions is using whitelisted methods with parameterized access and strict input validation. This prevents SQL injection and ensures document-specific actions are securely exposed.

How do I test REST APIs and handle errors in Frappe whitelisted methods?

Testing REST APIs in Frappe involves applying documented error handling patterns within your whitelisted methods. This ensures robust responses for authenticated endpoints and document-specific actions during client integration.