Sites API: Sites

Retrieves one specific site

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sitestring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/sites/{site}

HTTPcURLJavaScriptPython

GET /v2/e01/api/sites/{site} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific site

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

sitestring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/sites/{site}

HTTPcURLJavaScriptPython

HEAD /v2/e01/api/sites/{site} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/sites/collect

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 100

{
  "LastChangeTimeSince": "2026-05-10T07:23:18.088Z",
  "LastChangeTimeBefore": "2026-05-10T07:23:18.088Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "SiteId": "123e4567-e89b-12d3-a456-426614174000",
    "LastChangeType": "text",
    "LastChangeUser": "text",
    "SiteDomain": "text",
    "SiteTitle": "text",
    "LastChangeTime": "2026-05-10T07:23:18.088Z"
  }
]

Counts the sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/sites/count

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 100

{
  "LastChangeTimeSince": "2026-05-10T07:23:18.088Z",
  "LastChangeTimeBefore": "2026-05-10T07:23:18.088Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

post

/api/sites/download

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 100

{
  "LastChangeTimeSince": "2026-05-10T07:23:18.088Z",
  "LastChangeTimeBefore": "2026-05-10T07:23:18.088Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of sites that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

LastChangeTimeSincestring · date-time · nullableOptional

LastChangeTimeBeforestring · date-time · nullableOptional

Responses

200

OK

application/jsontext/json

post

/api/sites/search

HTTPcURLJavaScriptPython

POST /v2/e01/api/sites/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 100

{
  "LastChangeTimeSince": "2026-05-10T07:23:18.088Z",
  "LastChangeTimeBefore": "2026-05-10T07:23:18.088Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "SiteId": "123e4567-e89b-12d3-a456-426614174000"
  }
]