Skip to main content

Archive_ImportPage​

Archive_ImportPage

Path Parameters
  • site string required

    The site id.

Request Body required
  • parent string required

    The site parent of the page.

  • uri string required

    A publicly-accessible page HTTP/HTTPS URL. When fetching pages from HTTP/HTTPS URLs, Animeshon cannot guarantee that the request will be completed. Your request may fail if the specified host denies the request (e.g. due to request throttling or DoS prevention), or if Animeshon throttles requests to the site for abuse prevention.

  • cacheOptions object

    The WebCache options to be used when importing a page from a public site.

    • refresh boolean

      If refresh is set to true the page is imported from the remote address regardless of an existing local cache, if the fetched page does not match the existing cache the new page is stored and a new resource is created, otherwise the existing (cached) resource is returned.

    • ignore boolean

      If ignore is set to true no cache lookup is performed and the page is imported into a new resource. If both "ignore" and "refresh" are set to true then "refresh" has no effect.

Responses

OK

Schema
  • result object
    • name string

      The page resource name.

  • error object
    • statusCode int32

      The status code returned from the remote server.

    • details string

      The details related to the import failure.

  • cacheHit boolean

    Whether this page was found in the cache.