Skip to main content
POST
/
api
/
v1
/
enroll
Enroll Device
curl --request POST \
  --url https://api.promptguard.dev/api/v1/enroll \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "token": "<string>",
  "device_name": "<string>",
  "platform": "macos",
  "end_user_id": "<string>"
}
'
{
  "api_key": "<string>",
  "project_id": "<string>",
  "device_id": "<string>",
  "organization_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptguard.co/llms.txt

Use this file to discover all available pages before exploring further.

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

Response

Successful Response

​
api_key
string
required
​
project_id
string
required
​
device_id
string
required
​
organization_id
string
required