Disable an installation
Stops the installation at once: its events stop, and its credential is refused on every surface until it is enabled again.
POST
Stops the installation at once: its events stop, and its credential is refused on every surface until it is enabled again.
apiKeyheader
x-api-key<token>id*stringMatch
^exti_[0-9a-hjkmnp-tv-z]{16,24}$ExtensionInstallation
application/json- response
id*ExtensionInstallationIdMatch
^exti_[0-9a-hjkmnp-tv-z]{16,24}$extensionId*ExtensionIdMatch
^ext_[0-9a-hjkmnp-tv-z]{16,24}$name*stringdisplayName*stringversion*runtime*stringValue in
"hosted""webhook"status*stringValue in
"active""disabled"createdAt*stringevents*array<>permissions*array<>policy*scope*webhook*|nullupdatedAt*stringdisabledAt*string|nullimport { createClient } from "samva";
const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });
const result = await samva.extensionInstallations.disable({
"id": "example"
});Example Response
{
"id": "string",
"extensionId": "string",
"name": "string",
"displayName": "string",
"version": {
"id": "string",
"version": "string"
},
"runtime": "hosted",
"status": "active",
"createdAt": "string",
"events": [
"mailbox.message.received"
],
"permissions": [
"read"
],
"policy": {
"presets": [
"string"
],
"rules": [
{
"match": {
"kind": "send",
"effect": "read",
"channel": "sms",
"integration": "string",
"tool": "string",
"subject": "agent"
},
"note": "string",
"decide": "run",
"atLeast": null
}
],
"instructions": "string"
},
"scope": {
"mailboxIds": [
"string"
],
"namespaceId": "string"
},
"webhook": {
"endpointId": "string",
"url": "string"
},
"updatedAt": "string",
"disabledAt": "string"
}