ghostAPIv1 beta
Definitions

Enable or disable a module

POST/modules
ScopeadminRoleOwner or adminBilling1 credit per call

Toggles a module and sets which roles can see its definitions. Toggling does not start ingestion or backfills.

Headers

Idempotency-Keystringoptional
1–128 visible ASCII characters. Retrying with the same key returns the original response; reusing it for different input returns 409.

Body

moduleKeyenumrequired
customers · partners · investors · recruiting · advisors · vendors
enabledbooleanrequired
visibilityRolesenum[]optional
Any of owner · admin · analyst · member. At least one.
reasonstringrequired
Why this change is being made. 1–500 characters. Stored in the audit trail.

Response

successboolean