Revoke connection

Revokes Hyperspell’s access the given provider and deletes all stored credentials and indexed data.

DELETE /connections/{connection_id}/revoke

JavaScript

JavaScript

import Hyperspell from '@hyperspell/hyperspell';

const client = new Hyperspell({
  apiKey: process.env['HYPERSPELL_API_KEY'], // This is the default and can be omitted
});

const response = await client.connections.revoke('connection_id');

console.log(response.message);

200

{
  "success": true,
  "message": "<string>"
}

Authorizations

APIKeyAsUser

Authorization · string · header · required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Path Parameters

connection_id · string · required

Response

200

application/json

Successful Response

success · boolean · required

message · string · required