hackgatedName subdomain from your origin URL and organization slug automatically.
Request
Headers
string
required
Bearer token. Example:
Bearer <token>string
required
Must be
application/json.Body
string
required
The origin URL to proxy. Must be a full FQDN including scheme (e.g.
https://www.example.com). The following are not accepted:- URLs with query strings (
?key=value) - URLs with non-standard ports
- Origins already registered under another site (duplicates are rejected)
Validation errors
Response
Returns the newly created site object.string
required
Unique identifier for the site (UUID). Use this in all subsequent API calls.
string
required
The origin URL you provided.
string
required
The
hackgate.io subdomain provisioned for this site (e.g. www-myorg.hackgate.io).boolean
required
Initial active state of the site after creation.
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
true while proxy infrastructure is being provisioned. Deployment takes approximately 4 minutes. You cannot enable or disable the site until this is false.boolean
required
Whether a custom researcher allowlist is enabled.
false immediately after creation.string
Scheduled start date.
null immediately after creation.string
Scheduled stop date.
null immediately after creation.string
Test credentials for researchers.
null immediately after creation.string
Testing instructions for researchers.
null immediately after creation.string
Rate limiting rule.
null immediately after creation.string
JSON-encoded block rules.
null immediately after creation.After creation,
isDeploymentProgress is true while HackGATE provisions the proxy. All organization members receive an email when creation starts and a second email when the site is live (~4 minutes later).