GET /api/sites — list HackGATE sites

curl "https://api-admin.hackgate.io/api/sites?isActive=true&searchTerm=example" \
  -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
  }
]

Returns the full list of HackGATE sites in your organization. Use the query parameters to filter and sort the results.

Request

GET https://api-admin.hackgate.io/api/sites

Headers

string

required

Bearer token. Example: Bearer <token>

Query parameters

string

Field name to sort results by. Omit for default server ordering.

string

Filters results to sites whose originName or hackgatedName contains this string. Case-insensitive.

boolean

Active state filter. Currently the API returns all active sites for your organization regardless of this value.

Response

Returns an array of site objects.

object[]

Hide Site object fields

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 for this site.

boolean

required

true while the proxy infrastructure is being provisioned.

string

Scheduled start date (ISO 8601). null if no schedule is set.

string

Scheduled stop date (ISO 8601). null if no schedule is set.

string

Test credentials distributed to researchers. null if not set.

string

Testing instructions distributed to researchers. null if not set.

string

Rate limiting rule string. null if rate limiting is not configured.

string

JSON-encoded string of active block rules. null if no rules are configured.

Example

curl "https://api-admin.hackgate.io/api/sites?isActive=true&searchTerm=example" \
  -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
  }
]

curl "https://api-admin.hackgate.io/api/sites?isActive=true&searchTerm=example" \
  -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
  }
]

Overview

Sites

Projects

Analytics

Account & Org

Account

Analytics

Billing

Organization

PIE

Projects

Sites

GET /api/sites — list HackGATE sites

Request

Headers

Query parameters

Response

Example

​Request

​Headers

​Query parameters

​Response

​Example

Request

Headers

Query parameters

Response

Example