admin

Set Module Availability

Move one module to available, soon, or off.

Recorded twice over: set_by on the override row says who holds the current state, and admin_audit_log says who moved it and from what (ZEISO-302). The second is the one that answers "who took Trendyol down on Tuesday", because the first is overwritten by whoever changes it next.

put/api/admin/modules/{connector_key}

Request

  • Base URL: https://api.heymetra.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.heymetra.com/api/admin/modules/{connector_key}
  • Auth: none declared

Path parameters

connector_keystring required

Headers

authorizationstring nullable
x-workspace-idstring nullable

Request body

availability'available' | 'soon' | 'disabled' required

What a superadmin may say about one module (= connector), overriding the catalog's own availability.

Three values, and the third is the one this enum exists for. available and soon mirror core.catalog.connectors.Availability so an override can put a connector back exactly where the catalog would have had it; disabled has no catalog equivalent because a connector nobody may see is not a state source code should have to carry — it is an operational decision, taken at 2am when a provider's API breaks, and it must not wait for a deploy.

disabled means gone, not hidden: absent from the public catalog, from the dashboard, from the MCP tool listing, and refused on call. Rows already in the database are untouched — see core.catalog.availability.

Response

Successful Response

keystring required
namestring required
categorystring required
kindstring required
catalog_availabilitystring required
availability'available' | 'soon' | 'disabled' required

What a superadmin may say about one module (= connector), overriding the catalog's own availability.

Three values, and the third is the one this enum exists for. available and soon mirror core.catalog.connectors.Availability so an override can put a connector back exactly where the catalog would have had it; disabled has no catalog equivalent because a connector nobody may see is not a state source code should have to carry — it is an operational decision, taken at 2am when a provider's API breaks, and it must not wait for a deploy.

disabled means gone, not hidden: absent from the public catalog, from the dashboard, from the MCP tool listing, and refused on call. Rows already in the database are untouched — see core.catalog.availability.

overriddenboolean required
live_connectionsinteger required

Changes

No recorded changes to this operation across all 4 revisions of this API.