Skip to main content
POST
Enroll Device

Authorizations

X-API-Key
string
header
required

PromptGuard API key for developer endpoints. Keys start with pg_live_ and are created in the dashboard.

Body

application/json
token
string
required

Enrollment token from the admin

device_name
string
required

Hostname / device label

Maximum string length: 255
platform
string
default:macos

macos | windows | browser | linux

end_user_id
string | null

Employee attribution label

Maximum string length: 255
coverage
string
default:proxy

Capture tier the agent is running: 'extension' or 'proxy'

Response

Successful Response

api_key
string
required
project_id
string
required
device_id
string
required
organization_id
string
required
enforced
boolean
default:false
mode
string
default:enforce
fail_closed
boolean
default:true
end_user_label
string | null
account_name
string | null
account_type
string
default:personal