Skip to main content
Deactivates a HackGATE site. The proxy subdomain immediately stops forwarding traffic to your origin and serves a default offline page to any researcher who connects. A Stopped event is written to the site’s activity log.

​
Request

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

​
Headers

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

​
Path parameters

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

​
Errors

ConditionStatustitle
Site is already inactive400"Site is already disabled"
Site not found404Site not found message

​
Response

Returns the updated site object with isActive set to false.
​
id
string
required
Unique identifier for the site (UUID).
​
originName
string
required
The origin URL being proxied.
​
hackgatedName
string
required
The hackgate.io subdomain that now serves the offline page.
​
isActive
boolean
required
false after a successful disable 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
Deployment state at the time of the request.
​
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/disable/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": false,
  "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
}