Gets a list of the sites that match the specified search string and specified fields. Use the desired result count parameter to limit the number of results returned.
GET https://api-<DNS.Edge.URL>/v1/api/customer/sitesAndSiteGroups/search?nameContains= fragment&desiredResultCount=100 Authorization: Bearer token
Parameters
Name | Description | Type | Required |
nameContains | Search for site and site group names which contain the specified string. | String | Required |
desiredResultCount | The maximum number of records to return. | Integer | Required |
Successful response
Response is similar to /v3/api/sites (GET) but only lists sites and site groups which contain the provided string, and will stop once the the desired result count is reached.
200 OK Content-Type: application/JSON [ { "name": "Toronto Site", "type": "site or site group" "siteId": "a16a009e-4790-42b6-9374-b1b18e619d76", }, ... ]
Response on unsuccessful authorization
401 Unauthorized Content-Type: application/JSON {"code": "UNAUTHORIZED", "brief": "You are not authorized to perform this action"}
Possible error codes
|