core-controller-endpoints

What problem does it solve?

Guidance for securely creating, authenticating, and testing Core API endpoints used for administrative operations, data migrations, and support tooling in Cognito Forms, including the OrgIdentifier requirement, Overwatch token usage, and required headers.

Core Features & Use Cases

• Inherit from BaseCoreController to define endpoints under /core/api/organization/{orgId}
• Ensure the [OrgIdentifier] attribute is applied to the orgId parameter for authentication
• Retrieve and apply an Overwatch token for Core API authentication
• Enforce required headers such as X-Requested-By and Content-Length
• Debug and troubleshoot common 401 scenarios across local and feature environments
• Support safe migrations and tooling workflows with clear error handling and responses

Quick Start

Inherit from BaseCoreController, add [OrgIdentifier] to the orgId parameter, obtain an Overwatch token, and test the endpoint in the target environment.