v1

latestOpenAPI 3.1.02026-07-24730265.7 KB

Create Job Share Link with Password

post/api/v3/jobs/{job_id}/job_share

Path parameters

job_idstring required

ID of the job to share.

Request body

viewer_versionstring required

The type of viewer to use for the shared link.

password_protectedstring

Whether to password-protect the share. Note: virtual-walkthrough always requires password protection.

Response

200

idinteger

tokenstring

password_protectedboolean

expires_atstring

created_atstring

updated_atstring

urlstring

{"stackTrail":"paths:/api/v3/jobs/{job_id}/job_share:post:responses:200:content:application/json:schema:properties:generated_password","oasType":"schema","type":"unknown"}

Example response

{
  "id": 12345,
  "token": "zvXwgDcfjiL1q45NuScg",
  "expires_at": "2024-03-15T12:00:00.000Z",
  "created_at": "2024-01-30T12:00:00.000Z",
  "updated_at": "2024-01-30T12:00:00.000Z",
  "url": "https://hover.to/shared/zvXwgDcfjiL1q45NuScg"
}