Agent hosts

Revoke an agent host grant

Revokes one active agent-host grant when the authenticated automation client has agent_hosts.write. External URL: /v1/agent-host/grants/{grantId}/revoke. Current Next.js implementation path: /api/platform/v1/agent-host/grants/[grantId]/revoke. This mutating route requires Idempotency-Key, records audit/event evidence, hides affected tools, and makes future protected calls fail closed. It does not delete historical grant/action records or execute host actions.

post/agent-host/grants/{grantId}/revoke

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/agent-host/grants/{grantId}/revoke
  • Auth: HTTP bearer

Path parameters

grantIdstring uuid required

Agent host grant identifier.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Idempotency-Keystring required

Required for mutating platform routes. Accepted format: 8 to 128 ASCII characters matching [A-Za-z0-9._:-]+.

Request body

reasonstring required

Response

Agent host grant revoked or already revoked.

oktrue required
already_revokedboolean required
principalPrincipal required(unresolved $ref)
livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.