Returns the full list of HackGATE sites in your organization. Use the query parameters to filter and sort the results.
Request
Bearer token. Example: Bearer <token>
Query parameters
Field name to sort results by. Omit for default server ordering.
Filters results to sites whose originName or hackgatedName contains this string. Case-insensitive.
Active state filter. Currently the API returns all active sites for your organization regardless of this value.
Response
Returns an array of site objects.
Unique identifier for the site (UUID).
The origin URL being proxied (e.g. https://www.example.com).
The hackgate.io subdomain provisioned for this site (e.g. www-myorg.hackgate.io).
Whether the site is currently active and accepting researcher connections.
Organization ID that owns this site.
User ID of the account that created the site.
ISO 8601 timestamp of when the site was created.
Whether a custom researcher allowlist is enabled for this site.
true while the proxy infrastructure is being provisioned.
Scheduled start date (ISO 8601). null if no schedule is set.
Scheduled stop date (ISO 8601). null if no schedule is set.
Test credentials distributed to researchers. null if not set.
Testing instructions distributed to researchers. null if not set.
Rate limiting rule string. null if rate limiting is not configured.
JSON-encoded string of active block rules. null if no rules are configured.
Example
