GET /api/sites/enable/{id} — activate a site

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

string

required

Bearer token. Example: Bearer <token>

Path parameters

string

required

The UUID of the site to activate.

Errors

Condition	Status	`title`
Site is already active	`400`	`"Site is already active"`
Site is still deploying	`400`	`"Site deployment is in progress"`
Site not found	`404`	Site 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.

string

required

Unique identifier for the site (UUID).

string

required

The origin URL being proxied.

string

required

The hackgate.io subdomain now accepting researcher traffic.

boolean

required

true after a successful enable request.

string

required

Organization ID that owns this site.

string

required

User ID of the account that created the site.

string

required

ISO 8601 timestamp of when the site was created.

boolean

required

Whether a custom researcher allowlist is enabled.

boolean

required

false for a site that can be enabled.

string

Scheduled activation date, if set. null otherwise.

string

Scheduled deactivation date, if set. null otherwise.

string

Test credentials for researchers. null if not configured.

string

Testing instructions for researchers. null if not configured.

string

Rate limiting rule string. null if not configured.

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
}

{
  "title": "Site is already active",
  "status": 400
}

GET /api/sites/{id} — retrieve a single site

GET /api/sites/disable/{id} — deactivate a site

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
}

{
  "title": "Site is already active",
  "status": 400
}

Overview

Sites

Projects

Analytics

Account & Org

Account

Analytics

Billing

Organization

PIE

Projects

Sites

GET /api/sites/enable/{id} — activate a site

Request

Headers

Path parameters

Errors

Response

Example

​Request

​Headers

​Path parameters

​Errors

​Response

​Example

Request

Headers

Path parameters

Errors

Response

Example