PgBeam Docs
Platform

revokeSelfHostEnrollment

Revoke a self-host enrollment

Revokes an enrollment so its token can no longer authenticate a proxy. Connected proxies keep their last-known config until they reconnect.

Usage

const result = await api.platform.revokeSelfHostEnrollment({
  pathParams: {
    org_id: "org_abc123",
    enrollment_id: "she_01h455vb4pex5vsknk084sn02q",
  },
});

Parameters

ParameterTypeRequiredDescription
pathParams.org_idstringYesUnique organization identifier.
pathParams.enrollment_idstringYesUnique enrollment identifier.

Response

Promise<void>: no content.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbk_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.platform.revokeSelfHostEnrollment({
  pathParams: {
    org_id: "org_abc123",
    enrollment_id: "she_01h455vb4pex5vsknk084sn02q",
  },
});

Errors

StatusDescription
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.

On this page