Projects

Screenshot of the project's live site: state, version and failure reason (the first capture of a live project is queued on first read)

get/projects/{projectId}/screenshot/info

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/projects/{projectId}/screenshot/info
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

projectIdstring uuid required

Response

Screenshot state

projectIdstring uuid required
configuredboolean required
status'off' | 'none' | 'pending' | 'ready' | 'failed' required
versionstring nullable required
contentType'image/webp' | 'image/jpeg' | 'null' nullable required
capturedAtstring nullable required

ISO-8601 timestamp

urlstring nullable required
refreshingboolean required
requestedAtstring nullable required

ISO-8601 timestamp

lastError'no_public_url' | 'invalid_job' | 'dns_failure' | 'blocked_address' | 'navigation_blocked' | 'unreachable' | 'timeout' | 'protected' | 'site_error' | 'too_large' | 'browser_failed' | 'capture_timeout' | 'storage_full' | 'null' nullable required
lastAttemptAtstring nullable required

ISO-8601 timestamp

refreshAvailableAtstring nullable required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.