Type Alias WaybackSaveOptionsBeta

Type Declaration

• OptionalcaptureAll?: boolean

  Capture a web page with errors (HTTP status=4xx or 5xx). By default SPN2 captures only status=200 URLs.

  Default

  false
  Copy

• OptionalcaptureCookie?: string

  Use extra HTTP Cookie value when capturing the target page.

• OptionalcaptureOutlinks?: boolean

  Capture web page outlinks automatically. This also applies to PDF, JSON, RSS and MRSS feeds.

  Default

  false
  Copy

• OptionalcaptureScreenshot?: boolean

  Capture full page screenshot in PNG format. This is also stored in the Wayback Machine as a different capture.

  Default

  false
  Copy

• OptionaldelayWbAvailability?: boolean

  The capture becomes available in the Wayback Machine after ~12 hours instead of immediately. This option helps reduce the load on our systems. All API responses remain exactly the same when using this option.

  Default

  false
  Copy

• OptionalemailResult?: boolean

  Send an email report of the captured URLs to the user’s email.

  Default

  false
  Copy

• OptionalforceGet?: boolean

  Force the use of a simple HTTP GET request to capture the target URL. By default SPN2 does a HTTP HEAD on the target URL to decide whether to use a headless browser or a simple HTTP GET request.

• OptionalifNotArchivedWithin?: string | [string, string]

  Capture web page only if the latest existing capture at the Archive is older than the limit. Its format could be any datetime expression like "3d 5h 20m” or "ust a number of seconds, e.g. "120”. "f there is a capture within the defined timedelta, SPN2 returns that as a recent capture. The default system is 45 min. When using 2 values, the first one applies to the main capture and the second one applies to outlinks.

• OptionaljsBehaviorTimeout?: number

  Run JS code for seconds after page load to trigger target page functionality like image loading on mouse over, scroll down to load more content, etc. The default system is 5 sec. More details on the JS code we execute: https://github.com/internetarchive/brozzler/blob/master/brozzler/behaviors.yaml WARNING: The max value that applies is 30 sec. NOTE: If the target page doesn’t have any JS you need to run, you can use js_behavior_timeout=0 to speed up the capture.

  Default

  5;
  Copy

• OptionaloutlinksAvailability?: boolean

  Return the timestamp of the last capture for all outlinks.

  Default

  false
  Copy

• OptionalskipFirstArchive?: boolean

  Skip checking if a capture is a first if you don’t need this information. This will make captures run faster.

  Default

  false
  Copy

• OptionaluseUserAgent?: string

  Use custom HTTP User-Agent value when capturing the target page.

• { targetPassword?: undefined; targetUsername?: undefined }
• { targetPassword: string; targetUsername: string }

  • targetPassword: string

  • targetUsername: string

    Use your own username and password in the target page’s login forms.