Skip to content

Pause an integration

Block calls from attached Computers while keeping the integration's credentials and attachments.

Parameters

#
integrationstringRequired
Integration name in the selected account.
organizationstring
Organization name or ID. A credential, named resource or sole membership can select the organization for you.

Returns

#
dataobjectAlways present
The integration affected by this request.
Show 5 attributesHide attributes
addressstring
Address attached Computers use to call the integration. May be omitted.
detachedboolean
Whether detaching removed any of the attachments named. May be omitted.
idstringAlways present
Integration ID.
not_attachedstring[]
Attachments named to detach that it did not have. May be omitted.
pausedboolean
Whether the integration is now paused. May be omitted.

Errors

#
CodeStatusWhat happened
invalid400An input is missing or invalid.
unauthenticated401The credential is missing, invalid, expired or revoked.
denied403The caller lacks permission for this action.
not_found404The resource is absent or inaccessible to this caller.
conflict409The request conflicts with the current resource state or an earlier request.
over_capacity409The request exceeds a resource or credential allowance.
access_list_full409The change would exceed the access-list allowance.
payment_required402Payment or credit is required.
rate_limited429The caller's request rate exceeds its limit.
busy429Too much work is in progress to accept this request.
unknown503The outcome is unconfirmed; a change may have happened.
unavailable503The service or requested feature is unavailable.

Notes

#
  • CLI: heaven login with HEAVEN_API_KEY unset. MCP: Heaven sign-in. cURL: HEAVEN_SIGN_IN_KEY from approved device sign-in (POST /v1/auth/create).
  • A key limited to a command list cannot run this command.