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

​
Headers

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

​
Path parameters

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

​
Response

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

​
Example