Get Sites

description retrieves a list of sentinelone sites matching filter criteria to manage and organize network topology endpoint url /web/api/v2 1/sites method get inputs parameters (object) accountid (string) account id accountids (array) list of account ids to filter by accountname contain (array) free text filter by account name (supports multiple values) activelicenses (number) active licenses adminonly (boolean) show sites the user has admin privileges to availablemovesites (boolean) only return sites the user can move agents through countonly (boolean) if true, only total number of items will be returned, without any of the actual objects createdat (string) timestamp of site creation cursor (string) cursor position returned by the last request use to iterate over more than 1000 items description (string) the description for the site description contains (array) free text filter by site description (supports multiple values) expiration (string) expiration externalid (string) id in a crm external system features (array) if sent return only sites that support this features healthstatus (boolean) health status isdefault (boolean) is default limit (number) limit number of returned items (1 1000) module (string) module name (string) name name contains (array) free text filter by site name (supports multiple values) query (string) full text search for fields name, account name, description (note on single account consoles account name will not be matched) registrationtoken (string) registration token siteids (array) list of site ids to filter by sitetype (string) site type skip (number) skip first number of items (0 1000) to iterate over more than 1000 items, use "cursor" skipcount (boolean) if true, total number of items will not be calculated, which speeds up execution time sku (string) sku sortby (string) the column to sort the results by sortorder (string) sort direction state (string) site state states (array) list of states to filter totallicenses (number) total licenses updatedat (string) timestamp of last update output example \[ { "status code" 200, "response headers" { "server" "nginx", "date" "mon, 28 aug 2023 10 07 53 gmt", "content type" "application/json", "transfer encoding" "chunked", "connection" "keep alive", "x rqid" "fb4ea2f2 3f64 4aa0 817d 7f77429fd646", "access control allow origin" "https //usea1 identity sentinelone net", "access control allow credentials" "true", "vary" "origin", "strict transport security" "max age=31536000; includesubdomains", "x frame options" "sameorigin", "x content type options" "nosniff", "content security policy" "default src 'self' ; connect src 'self' sentinelone net cdn pendo io app pendo io pendo io data pendo io scalyr com storage googleapis com sentry io sentry io google analytics com gstatic com unpkg com cdn auth0 com wss\ // sentinelone net https //www googletagmanager com https //cdnjs cloudflare com data ; script src 'self' 'unsafe inline' 'unsafe eval' cdn pendo io app pendo io pendo io static storage googleapis com cdn pendo io storage googleapis com data pendo io https //www google analytics com https //www googletagmanager com https //unpkg com https //cdnjs cloudflare com ; img src 'self' data https //www google analytics com cdn pendo io app pendo io sentinelone com storage googleapis com data pendo io ; style src 'self' 'unsafe inline' app pendo io cdn pendo io storage googleapis com https //cdnjs cloudflare com ; font src 'self' data https //cdn auth0 com ; frame src 'self' blob https //receptive io https // pendo io https //pendo io extensions storage googleapis com/ https // youtube com ; frame ancestors 'self' app pendo io ; object src 'none'", "cache control" "no store", "pragma" "no cache", "expires" " 1", "content encoding" "gzip" }, "reason" "ok", "json body" { "data" { "allsites" { "activelicenses" 764, "totallicenses" 40 }, "sites" \[ { "accountid" "1286405255240245908", "accountname" "swimlane", "activelicenses" 2, "createdat" "2021 11 10t21 37 36 553082z", "creator" "sandeep minhas", "creatorid" "1170348439571106212", "description" null, "expiration" null, "externalid" "33c29bd6 a9ff 3881 ad02 b80a19baa4ec", "healthstatus" true, "id" "1286405255257023125", "isdefault" true, "licenses" { "bundles" \[ { "displayname" "core", "majorversion" 1, "minorversion" 4, "name" "core", "surfaces" \[ { "count" 25, "name" "total agents" } ], "totalsurfaces" 25 } ], "modules" \[ { "displayname" "ranger", "majorversion" 1, "name" "ranger" } ], "settings" \[ { "displayname" "365 days", "groupname" "malicious data retention", "setting" "365 days", "settinggroup" "malicious data retention", "settinggroupdisplayname" "malicious data retention" }, { "displayname" "available", "groupname" "marketplace access status", "setting" "available", "settinggroup" "marketplace access status", "settinggroupdisplayname" "marketplace access" }, { "displayname" "account", "groupname" "account level ranger", "setting" "account", "settinggroup" "account level ranger", "settinggroupdisplayname" "ranger consolidation level" } ] }, "name" "default site", "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiaiywi0zwuwngm3zdy2zwrlzcj9", "sitetype" "paid", "sku" "core", "state" "active", "suite" "core", "totallicenses" 25, "unlimitedexpiration" true, "unlimitedlicenses" false, "updatedat" "2023 08 27t08 04 39 306240z" }, { "accountid" "1286405255240245908", "accountname" "swimlane", "activelicenses" 0, "createdat" "2023 08 24t21 24 49 803179z", "creator" "travis riley", "creatorid" "1286405906565325677", "description" "content team test site", "expiration" null, "externalid" null, "healthstatus" true, "id" "1758952600032266153", "isdefault" false, "licenses" { "bundles" \[ { "displayname" "complete", "majorversion" 1, "minorversion" 7, "name" "complete", "surfaces" \[ { "count" 10, "name" "total agents" } ], "totalsurfaces" 10 } ], "modules" \[ { "displayname" "remote script orchestration", "majorversion" 1, "name" "rso" }, { "displayname" "star", "majorversion" 1, "name" "star" } ], "settings" \[ { "displayname" "enabled", "groupname" "remote shell availability", "setting" "enabled", "settinggroup" "remote shell availability", "settinggroupdisplayname" "remote shell" }, { "displayname" "365 days", "groupname" "malicious data retention", "setting" "365 days", "settinggroup" "malicious data retention", "settinggroupdisplayname" "malicious data retention" }, { "displayname" "available", "groupname" "marketplace access status", "setting" "available", "settinggroup" "marketplace access status", "settinggroupdisplayname" "marketplace access" }, { "displayname" "14 days", "groupname" "dv retention", "setting" "14 days", "settinggroup" "dv retention", "settinggroupdisplayname" "deep visibility data retention" } ] }, "name" "content test site", "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiainzzmnmiwmjhlzgywntkymij9", "sitetype" "trial", "sku" "complete", "state" "active", "suite" "complete", "totallicenses" 10, "unlimitedexpiration" true, "unlimitedlicenses" false, "updatedat" "2023 08 27t08 04 39 306240z" }, { "accountid" "1286405255240245908", "accountname" "swimlane", "activelicenses" 0, "createdat" "2023 08 24t21 26 37 249272z", "creator" "travis riley", "creatorid" "1286405906565325677", "description" null, "expiration" null, "externalid" null, "healthstatus" true, "id" "1758953501354646085", "isdefault" false, "licenses" { "bundles" \[ { "displayname" "core", "majorversion" 1, "minorversion" 4, "name" "core", "surfaces" \[ { "count" 5, "name" "total agents" } ], "totalsurfaces" 5 } ], "modules" \[], "settings" \[ { "displayname" "365 days", "groupname" "malicious data retention", "setting" "365 days", "settinggroup" "malicious data retention", "settinggroupdisplayname" "malicious data retention" }, { "displayname" "available", "groupname" "marketplace access status", "setting" "available", "settinggroup" "marketplace access status", "settinggroupdisplayname" "marketplace access" } ] }, "name" "content second site", "registrationtoken" "eyj1cmwioiaiahr0chm6ly91c2vhms1wyxj0bmvycy5zzw50aw5lbg9uzs5uzxqilcaic2l0zv9rzxkioiaizgjjzje2zddkndkwmta1zcj9", "sitetype" "trial", "sku" "core", "state" "active", "suite" "core", "totallicenses" 5, "unlimitedexpiration" true, "unlimitedlicenses" false, "updatedat" "2023 08 27t08 04 39 306240z" } ] }, "pagination" { "nextcursor" null, "totalitems" 3 } } } ] output parameters status code (number) reason (string) json body (object) data (object) allsites (object) activelicenses (number) totallicenses (number) sites (array) accountid (string) accountname (string) activelicenses (number) createdat (string) creator (string) creatorid (string) description (object) expiration (object) externalid (object) healthstatus (boolean) id (string) isdefault (boolean) licenses (object) bundles (array) displayname (string) majorversion (number) minorversion (number) name (string) surfaces (array) count (number) name (string) totalsurfaces (number) modules (array) file name (string) – required file (string) – required settings (array) displayname (string) groupname (string) setting (string) settinggroup (string) settinggroupdisplayname (string) name (string) registrationtoken (string) sitetype (string) sku (string) state (string) suite (string) totallicenses (number) unlimitedexpiration (boolean) unlimitedlicenses (boolean) updatedat (string) pagination (object) nextcursor (object) totalitems (number) response headers header type server string date string content type string transfer encoding string connection string x rqid string access control allow origin string access control allow credentials string vary string strict transport security string x frame options string x content type options string content security policy string cache control string pragma string expires string content encoding string