Skip to main content
Activates a HackGATE site and makes the proxy subdomain live. Researchers can connect via the hackgatedName subdomain immediately after the site is enabled. A Started event is written to the site’s activity log.

​
Request

GET https://api-admin.hackgate.io/api/sites/enable/{id}

​
Headers

​
Authorization
string
required
Bearer token. Example: Bearer <token>

​
Path parameters

​
id
string
required
The UUID of the site to activate.

​
Errors

ConditionStatustitle
Site is already active400"Site is already active"
Site is still deploying400"Site deployment is in progress"
Site not found404Site not found message
You cannot enable a site while isDeploymentProgress is true. Wait for deployment to complete before enabling.

​
Response

Returns the updated site object with isActive set to true.
​
id
string
required
Unique identifier for the site (UUID).
​
originName
string
required
The origin URL being proxied.
​
hackgatedName
string
required
The hackgate.io subdomain now accepting researcher traffic.
​
isActive
boolean
required
true after a successful enable request.
​
orgId
string
required
Organization ID that owns this site.
​
cretedByUserId
string
required
User ID of the account that created the site.
​
creationdDate
string
required
ISO 8601 timestamp of when the site was created.
​
hasCustomList
boolean
required
Whether a custom researcher allowlist is enabled.
​
isDeploymentProgress
boolean
required
false for a site that can be enabled.
​
startDate
string
Scheduled activation date, if set. null otherwise.
​
stopDate
string
Scheduled deactivation date, if set. null otherwise.
​
credentials
string
Test credentials for researchers. null if not configured.
​
instructions
string
Testing instructions for researchers. null if not configured.
​
rateLimit
string
Rate limiting rule string. null if not configured.
​
blockList
string
JSON-encoded block rules. null if not configured.

​
Example

curl https://api-admin.hackgate.io/api/sites/enable/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "Authorization: Bearer <token>"

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "originName": "https://www.example.com",
  "hackgatedName": "www-myorg.hackgate.io",
  "isActive": true,
  "orgId": "org-uuid",
  "cretedByUserId": "user-uuid",
  "creationdDate": "2024-06-01T10:00:00Z",
  "hasCustomList": false,
  "isDeploymentProgress": false,
  "startDate": null,
  "stopDate": null,
  "credentials": null,
  "instructions": null,
  "rateLimit": null,
  "blockList": null
}