Skip to main content

Profiles

🚧 Coming Soon — This API is under active design. Endpoints return 501 Not Implemented until released.

Profiles are the top-level organizational unit in the Transform Platform. A profile represents a client, team, or data-source pipeline and acts as a namespace that groups all related resources together.

What a Profile Provides​

  • Namespace — specs, integrations, credentials, windows, and actions are scoped to a profile
  • Access control — future: per-profile API keys and RBAC roles
  • Audit trail — all activity within a profile is tracked separately
  • Metadata — attach custom key-value tags (region, tier, owner, cost-centre)

Planned Workflow​

  1. Create a profile: POST /api/v1/profiles
  2. Create specs scoped to the profile
  3. Register integrations (SFTP, S3, etc.) under the profile
  4. Configure windows and actions referencing the profile
  5. Delete the profile (cascades to all child resources)

Operations​

📄️ List profiles

🚧 *Coming Soon* — Returns all client profiles.

📄️ Create a profile

🚧 *Coming Soon* — Create a new client profile.

📄️ Get profile by ID

🚧 *Coming Soon* — Retrieve a profile by its unique ID.

📄️ Update a profile

🚧 *Coming Soon* — Update an existing profile.

📄️ Delete a profile

🚧 *Coming Soon* — Delete a profile and all its associated resources.

📄️ Enable a Profile

🚧 *Coming Soon* — Activate a disabled profile so it begins processing events.

📄️ Disable a Profile

🚧 *Coming Soon* — Pause a profile without deleting it. In-flight windows are allowed to complete.

📄️ Validate a Profile config

🚧 *Coming Soon* — Dry-run validation of a profile's full configuration — windows, actions, and integration bindings — without persisting changes.

📄️ Rollback to a previous version

🚧 *Coming Soon* — Revert the profile configuration to a specific historical revision.

📄️ Get Profile revision history

🚧 *Coming Soon* — Returns ordered configuration revisions for a profile, newest first.

📄️ Manually trigger ON_MANUAL_TRIGGER actions

🚧 *Coming Soon* — Fire all actions on this profile that have trigger type `ON_MANUAL_TRIGGER` immediately.

Schema References​