Skip to main content
POST
/
compliance
/
{linkID}
/
enforce
SDK (@phosra/sdk)
import { PhosraClient } from "@phosra/sdk";

const phosra = new PhosraClient({
  baseUrl: "https://phosra-api-sandbox-production.up.railway.app/api/v1",
  accessToken: process.env.PHOSRA_API_KEY,
});

const result = await phosra.compliance.enforce("c0ffee00-1234-4567-89ab-cdef01234567");
console.log(result);

{
  "id": "b8f04d2e-1c93-4a56-8e7f-05a91d6c3b28",
  "child_id": "ca02f5d1-fee8-4201-b5ca-fdc8be506e1e",
  "policy_id": "7b3e9c04-2d1a-4f68-9e5b-8c07a1f34d29",
  "trigger_type": "manual",
  "status": "pending",
  "started_at": "2026-06-30T09:15:44Z",
  "completed_at": "2026-06-30T09:15:52Z",
  "created_at": "2026-06-18T14:32:07Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
linkID
string<uuid>
required

Response

Enforcement job started

​
id
string<uuid>

Unique identifier for this resource.

​
child_id
string<uuid>

Identifier of the child this resource belongs to.

​
policy_id
string<uuid>

Identifier of the policy this resource belongs to.

​
trigger_type
enum<string>

What initiated the job (e.g. manual, scheduled, policy_change).

Available options:
manual,
auto,
webhook
​
status
enum<string>

Current lifecycle state of the resource.

Available options:
pending,
running,
completed,
failed,
partial
​
started_at
string<date-time> | null

RFC 3339 timestamp of when the job started running.

​
completed_at
string<date-time> | null

RFC 3339 timestamp of when the job finished.

​
created_at
string<date-time>

RFC 3339 timestamp of when the resource was created.