Skip to main content
Returns the complete configuration for a single HackGATE site. Use this endpoint to read a site’s current state, scheduling, credentials, instructions, rate limit, and block rules.

​
Request

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

​
Headers

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

​
Path parameters

​
id
string
required
The UUID of the site to retrieve. Returned as id when the site is created.

​
Response

Returns the full site object.
​
id
string
required
Unique identifier for the site (UUID).
​
originName
string
required
The origin URL being proxied (e.g. https://www.example.com).
​
hackgatedName
string
required
The hackgate.io subdomain provisioned for this site (e.g. www-myorg.hackgate.io).
​
isActive
boolean
required
Whether the site is currently active and accepting researcher connections.
​
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. When true, only emails on the allowlist can connect.
​
isDeploymentProgress
boolean
required
true while the proxy infrastructure is being provisioned. Enable and disable operations are blocked while this is true.
​
startDate
string
Scheduled activation date (ISO 8601). null if no schedule is set.
​
stopDate
string
Scheduled deactivation date (ISO 8601). null if no schedule is set.
​
credentials
string
Test credentials distributed to researchers. null if not configured.
​
instructions
string
Testing instructions distributed to researchers. null if not configured.
​
rateLimit
string
Rate limiting rule string applied at the proxy. null if rate limiting is not configured.
​
blockList
string
JSON-encoded string of block rules. null if no block rules are configured. Decode this string to read the individual rule objects.

​
Example

curl https://api-admin.hackgate.io/api/sites/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": "2024-07-01T08:00:00Z",
  "stopDate": "2024-07-31T18:00:00Z",
  "credentials": "username: tester\npassword: hunter2",
  "instructions": "Focus on the /api endpoints. Avoid /admin.",
  "rateLimit": "100r/m",
  "blockList": "[{\"pathPrefix\":\"/admin\",\"methods\":[\"*\"],\"status\":403,\"enabled\":true}]"
}