API Changelog

Track changes to the Proctorio API across versions.

Aug 12, 20262.0.101 – 2.0.121

Breaking

  • API key authentication moved from header to path
  • Fields number, duration, navigating_away and 7 more now use object type (was integer)
  • Removed maximum length requirements from 24 fields
  • Removed field: exam_name

Other Changes

  • Added new optional field: pre_auth_bypass
Feb 10, 20262.0.99 – 2.0.100

Minor fixes and improvements

Jan 19, 20262.0.81 – 2.0.91

Changes

  • Added new optional field: break_settings
  • Added new optional field: branding
  • Added new optional field: proctor_settings
  • New schemas breakSettingsRequest, brandingRequest, liveProctorSettings added
  • Added new optional field: branding
  • Added new optional field: post_auth
Nov 7, 20252.0.78

Minor fixes and improvements

Nov 3, 20252.0.77

Minor fixes and improvements

Oct 31, 20252.0.76

Minor fixes and improvements

Oct 30, 20252.0.75

Minor fixes and improvements

May 21 – Sep 29, 20252.0.60 – 2.0.74

Minor fixes and improvements (15 releases)

May 9, 20252.0.59

Breaking

  • Updated request format for POST /v2/candidate/launch
  • Updated request format for POST /v2/reviewer/launch
  • Updated request format for POST /v2/live/launch
  • API key authentication moved from header to path
  • Server URL removed: https://.api.proctorio.com
  • Schemas LiveLaunchRequestV2, BehaviorSettingsV2Request, BrandingRequest and 4 more removed

Other Changes

  • Server URL added: https://us1.proctorapi.com
  • New schemas windowsAllowedApp, examSettingsRequestV2, redirectSettings and 6 more added
Oct 23 '24 – Apr 14 '252.0.40 – 2.0.58

Minor fixes and improvements (19 releases)

Oct 22, 20242.0.39

Breaking

  • Removed field: domain
  • Removed field: live_roster
  • Removed field: apps_available
  • Removed field: allowed_ips
  • Changed roster_url maxLength: 500 → 600
  • Changed accent_color minLength: 1 → 6
  • Changed logo_url maxLength: 500 → 600
  • The redirect_url field now requires at least 1 character
  • Schema AppsAvailableRequest removed
  • Renamed field name to display_name
  • Renamed field photo to photo_url

Other Changes

  • Added new optional field: proctor_roster_url
  • Added new optional field: proxy_bypass_ips
  • Added new optional field: attempt_id
Oct 15 – Oct 18, 20242.0.36 – 2.0.38

Minor fixes and improvements (3 releases)

Oct 4, 20242.0.35

Breaking

  • Updated request format for POST /v2/live/launch
  • Simplified allowed characters for user_id

Other Changes

  • Added new optional field: branding
  • Added new optional field: allowed_ips
  • Added new optional field: redirect_url
Jun 14 – Aug 21, 20242.0.27 – 2.0.34

Minor fixes and improvements (8 releases)

May 29, 20242.0.26

Breaking

  • Changed launch_url maxLength: 500 → 600
  • Changed exam_start maxLength: 500 → 600
  • Changed exam_end maxLength: 500 → 600

Other Changes

  • New endpoint: POST /v2/live/launch
  • Added new optional field: exam_name
Apr 8 – May 29, 20242.0.18 – 2.0.25

Minor fixes and improvements (8 releases)

Apr 4, 20242.0.17

Minor fixes and improvements

Apr 1, 20242.0.16

Breaking

  • Renamed field right_click to disable_right_click
  • Removed field: live_proctor
  • Removed field: incognito_required
  • Removed field: disable_extensions
Mar 15 – Mar 18, 20242.0.9 – 2.0.15

Minor fixes and improvements (7 releases)

Mar 14, 20242.0.8

Breaking

  • Removed endpoint: POST /v2/take
  • Removed endpoint: POST /v2/review
  • Removed field: multi_face
  • Schemas InstructorLaunchRequestV2, TestTakerLaunchRequestV2 removed
  • Renamed field clipboard to disable_clipboard
  • Renamed field print to disable_printing
  • Renamed field downloads to block_downloads
  • Renamed field cache to clear_cache
  • Renamed field multiple_face to multiple_faces

Other Changes

  • New endpoint: POST /v2/candidate/launch
  • New endpoint: POST /v2/reviewer/launch
Mar 14 – Mar 14, 20242.0.1 – 2.0.7

Minor fixes and improvements (7 releases)