Skip to main content
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

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

​
Query parameters

​
orderBy
string
Field name to sort results by. Omit for default server ordering.
​
searchTerm
string
Filters results to sites whose originName or hackgatedName contains this string. Case-insensitive.
​
isActive
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[]

​
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
  }
]