Upgrading
This page is for moving to a newer release, or to plycdn.com. What changed in each release, and what is new, is in the Release notes; this page says what to do about it.
| You are on | Read |
|---|---|
| Content Search before 1.6 (the earlier product name and package names) | "Moving to plycdn.com" and "Content Search: moving to plycdn 1.6", then the 1.7 and 1.10 steps |
| Content Search 1.6 | "Content Search: moving to 1.7", then "Content Search 1.10.0" in the release notes (upgrading from 1.6.0) |
Storage & video 1.1.x (Plycdn.AspNetCore, @plycdn/angular and @plycdn/react with one entry point) |
"Storage & video 1.2.0" in the release notes: the packages are split by purpose and renamed |
Content Search 1.39.0 and Storage & video 1.30.0 need nothing from existing integrations. Moving a bucket from another cloud is new
and off until you set it up: Moving from another cloud. The only visible change in an
existing answer is that a domain on a moving bucket lists a third DNS record, with a purpose.
Content Search 1.37.0 and Storage & video 1.28.0 need nothing from existing integrations. <plycdn-content-document> and
<plycdn-content-playback> keep their inputs, outputs and labels, and now run on the file viewer: <plycdn-content-document>
shows a card for PowerPoint and ZIP files instead of failing, and a workbook opens with its sheets as tabs. If your code reached
into <plycdn-content-document> for members that were never documented (loading, lines, sheets, blocks, frame,
marked, trackPart, isHit, isRow, isBlock and pdfPages), show the file with <plycdn-content-file-viewer> and read its
state from that component's (stateChange) instead; mode now reads 'pdf-frame' where it read 'pdf'. A PDF that
<plycdn-content-playback> opens is a search result or an indexed file, so it still falls back to the browser's own viewer on
storage that doesn't allow cross-origin reads. The one case that changes: a .pdf you give <plycdn-content-document> by URL
alone, on such storage, now shows the card with its download, because nothing says the file is a PDF until its first bytes
are read. Set [knownPdf]="true" on it when you know the file is an indexed PDF, or allow your page's origin on the storage. To show a stored file or a search result anywhere in your page, add the viewer:
Showing any file.
Content Search 1.36.0 and Storage & video 1.27.0 need no change to your code, with one thing to check: a query refused because your
organization already has eight statements running, or has used its hourly read allowance, is now query_busy or
read_quota_exceeded (429, retryable, with Retry-After) instead of query_too_expensive (400). If your code matched the old code,
match these to wait and send again; the Node.js and Python packages already wait for a short Retry-After, and raise a long one
(the hourly allowance) at once. Earlier Node.js and Python packages wait up to about two minutes before raising
read_quota_exceeded: set maxRetries (Node.js) or max_retries (Python) to 0 for interactive calls if that matters. Observability's daily stored size steps down on the
day you move, because the tag we add to each row is no longer counted (release notes).
Content Search 1.35.0 and Storage & video 1.26.0 need nothing from existing integrations: the viewer watermark and player logo stay off until you switch them on. Before you set a library to Require the watermark, install the new versions of both your server package and your browser package (React or Angular) and check your application plays a video with Show: older packages, players of your own that don't draw it and plain links can't play a library that requires it (Viewer watermark and your logo).
Content Search 1.31.0 and Storage & video 1.22.0 need nothing from existing integrations. To stop copying package
files into your repository, switch to the plycdn feeds once: add the setup line for your tool (an .npmrc line, a
nuget.config source with package source mapping, or --index-url https://pypi.plycdn.com/simple/ for pip), remove the
local package files and their ./vendor references, and install by name. Every step is in
Install the SDKs.
Content Search 1.20.0 needs nothing from existing integrations: everything new is a field you send when you want it
(context, ranking, timeoutMs, quotes) or a new read (GET /assets/{id}/passages). Install the new versions of the
packages you use together, as before.
Content Search 1.19.0 and Storage & video 1.11.0 need nothing from existing integrations: they add server packages for Node.js (@plycdn/content-search-node,
@plycdn/node) and Python (plycdn-content-search, plycdn), which you install only if you want them. Install the new versions of the packages you already use together, as before.
Moving to Content Search 1.11.0 or Storage & video 1.3.0 needs no change to your code: both are additions
(delivery analytics, with PlycdnSignOptions.Tags and new reads). What is new is in "Added in Content Search 1.11.0
and Storage & video 1.3.0" in the release notes. Install the new package versions together, as before; analytics
stays off for a bucket or library until you switch it on.
Storage & video 1.4.0 signs plycdn links in your process. If you stay on an earlier version, links for buckets with plycdn links are signed by plycdn (one extra call per link); upgrade when convenient. Content Search 1.12.0 changes nothing you call.
From Content Search 1.15 to 1.16 and Storage & video 1.7 to 1.8: install the new versions together; nothing to edit. If you made your own plycdn bucket searchable through an S3-compatible connector, turn on the bucket's search switch instead and delete that connector and its storage credential.
Content Search 1.15.1 and Storage & video 1.7.1 change nothing you call: install the new package versions together. The live players now switch smoothly to a stream's other qualities when they arrive after it goes on air.
Content Search 1.15.0 and Storage & video 1.7.0 change nothing you call: install the new package versions together. One thing to know: through the ASP.NET Core package's browser controller, the activity list now shows each signed-in person only the files they may see, as search does. The assistant is new and optional; if your application compresses responses, leave text/event-stream out of the compressed types so answers arrive as they are written.
Content Search 1.14.1 changes nothing you call: install the three Content Search packages together (Storage & video stays at 1.6.0).
Content Search 1.14.0 and Storage & video 1.6.0 need no change to your code: they add live share links, watch-page branding and your own watch domains (see "New in Content Search 1.14.0 and Storage & video 1.6.0" in the release notes). Install the new package versions together, as before.
Moving to Content Search 1.13.0 or Storage & video 1.5.0 needs no change to your code: both are additions (live streaming). What is new is in "Added in Content Search 1.13.0 and Storage & video 1.5.0" in the release notes. Install the new package versions together, as before. Four things to know when you move:
.NET
PlaybackLinkhas one more member,Protection. Code that reads its properties keeps working as it is. Code that constructs aPlaybackLinkitself (a test double, say) or deconstructs it positionally needs one more argument (null) and a rebuild.A video's
statuscan now belive, for the video of a live stream that is on air. Nothing creates one until you create a live input, but code that handles every status should handle this one: treat it as playable with a moving end, and expect it to becomeplayableandreadywhen the stream ends. A video made by a stream also carriesliveInputIdandlive.Webhook endpoints keep the events they have; subscribe one to
live.startedandlive.endedto hear about broadcasts. Those events carrydata.liveInputIdanddata.streamId, notdata.video: a receiver that assumes every event has a video should check the event type first.Going live from a browser is refused for everyone until you register an
IPlycdnLiveAuthorizer, the way the storage routes are refused until you register anIPlycdnStorageAuthorizer. Code that createsPlycdnVideoControlleritself (a test, say) keeps working with the earlier constructor, which refuses going live from the browser; MVC uses the new one, which takes yourIPlycdnLiveAuthorizer.
The same releases also add, with nothing to change in existing code:
- .NET: live input settings
BackupIngest,RedundantTranscoding,Captions,DvrWindowSeconds,IndexRecording,ProtectionandAds; the callsGetStreamCaptionsAsync,GetStreamViewersAsync,GetStreamHealthAsync,CreateDestinationAsync,ListDestinationsAsync,UpdateDestinationAsync,DeleteDestinationAsync,TestDestinationAsyncandInsertAdBreakAsync;PlycdnVideoSigner.SignVideoFromPlycdnAsync(use it for the recording of a protected stream: a link signed locally carries no protection); the browser routeGET api/plycdn/v1/live-streams/{id}/captions, decided by yourIPlycdnStorageAuthorizerwithPlycdnOperation.GetVideo; the webhook eventslive.failover,live.destination_failedandlive.ad_break. - Angular and React: the live player's captions menu, rewind seek bar and keys, ad break badge and events (
(adEvent),onAdEvent), protected playback, andgetStreamCaptions. The packages now also install the client some real-time streams play with; it is loaded only when such a stream plays. - Webhook endpoints get the three new events only once you subscribe them; a receiver should ignore event types it does not know.
For help at any step, contact your plycdn representative.
1Moving to plycdn.com
Your server talks to the hosted API at https://api.plycdn.com/. That is the default of the Content
Search package (Plycdn.ContentSearch.AspNetCore) and of the storage and video packages
(Plycdn.AspNetCore.Storage and .Video), so the server-side change is to remove any Plycdn:ApiBaseUrl
setting (environment variable Plycdn__ApiBaseUrl) that names an older host. Set it only if your plycdn
contact gives you another HTTPS address:
{ "Plycdn": { "ApiKey": "<your key, from your secret store>" } }
- Your API key does not change.
- If your servers restrict outbound traffic, allow
api.plycdn.comon port 443. - The browser packages never call the API directly; they call your backend, so they need no address.
- Your dashboard is at https://plycdn.com/app, and the guides are at https://plycdn.com/docs.
2Content Search: moving to plycdn 1.6
Content Search now ships as plycdn. It is the same service with the same data: your library, indexes, collections, settings and API key all stay exactly as they are. What changes is the package names, the address your backend calls, and the route your backend serves to the browser.
There is no downtime and no deadline pressure. The previous address keeps working while you move, so you can make the change in your own release cycle. Nothing needs re-uploading or re-indexing.
You need your backend (.NET) developer, your frontend (Angular) developer, and someone who can sign in to the plycdn dashboard at https://plycdn.com/app, with the same email and password as before. Allow about an hour, plus your normal deployment.
What the 1.6.0 bundle contains
| File | What it is |
|---|---|
Plycdn.ContentSearch.AspNetCore.1.6.0.nupkg |
The ASP.NET Core package (.NET 6-10) |
plycdn-content-search-1.6.0.tgz |
The Angular package (Angular 13-22) |
plycdn-content-search-react-1.6.0.tgz |
The React package, if you use React |
| (the guides) | Published at https://plycdn.com/docs |
SHA256SUMS |
Checksums, to confirm the files arrived intact |
Do the numbered steps in order. Step 3 must follow the deployment of steps 1 and 2, because the new packages answer only on the new route.
Backend (ASP.NET Core)
Replace the package and rename what it provides. Nothing else in your code changes: every method, option and type keeps its name apart from the prefix.
| Before | After |
|---|---|
Package Proctored.ContentSearch.AspNetCore |
Plycdn.ContentSearch.AspNetCore |
AddProctoredContentSearch(...) |
AddPlycdnContentSearch(...) |
AddProctoredAzureBlobStorage(...) |
AddPlycdnAzureBlobStorage(...) |
Configuration section "Proctored" |
"Plycdn" |
Environment variables Proctored__ApiKey and so on |
Plycdn__ApiKey, Plycdn__CallbackKey, Plycdn__CallbackSecret, Plycdn__Azure__ConnectionString |
Organization claim proctored_organization_id |
plycdn_organization_id |
Browser route /api/proctored-content/v1 |
/api/plycdn-content/v1 (served automatically) |
Service address https://proctored.io/ |
https://api.plycdn.com/ (the default) |
dotnet remove package Proctored.ContentSearch.AspNetCore
dotnet add package Plycdn.ContentSearch.AspNetCore --version 1.18.0 --source ./vendor/nuget
"Plycdn": {
"ApiKey": "your existing API key",
"CallbackKey": "your existing callback key",
"CallbackSecret": "your existing callback secret"
}
- Keep your API key, callback key and callback secret. They are unchanged.
- Remove any
ApiBaseUrlsetting that names the old address. The package already defaults tohttps://api.plycdn.com/; setApiBaseUrlonly if your plycdn contact gives you another. - If your servers restrict outbound traffic, allow
api.plycdn.comon port 443. - If a reverse proxy, gateway rule or firewall mentions
/api/proctored-content/v1, change it to/api/plycdn-content/v1. YourPublicReadBaseUrlandPublicWriteBaseUrlsettings stay as they are.
Frontend (Angular)
| Before | After |
|---|---|
Package @proctored/content-search |
@plycdn/content-search |
ProctoredContentSearchModule |
PlycdnContentSearchModule |
<proctored-content-upload>, -search, -results, -playback, -document |
<plycdn-content-upload>, -search, -results, -playback, -document |
apiBaseUrl: '/api/proctored-content/v1' |
apiBaseUrl: '/api/plycdn-content/v1' |
CSS variable --proctored-accent |
--plycdn-accent (the --pcs-* variables are unchanged) |
npm uninstall @proctored/content-search
npm install ./vendor/plycdn-content-search-1.6.0.tgz
import { PlycdnContentSearchModule } from '@plycdn/content-search';
PlycdnContentSearchModule.forRoot({ apiBaseUrl: '/api/plycdn-content/v1' })
A find-and-replace of proctored-content with plycdn-content and Proctored with Plycdn across
your templates and modules covers almost all of it. Search results now come one card per file,
with a jump-to link for each place it matched. Set [groupByFile]="false" on
<plycdn-content-search> if you want one result per passage instead.
Update the callback address
Do this as soon as the new backend is live. Until then, leave it pointing at the old route.
- Sign in at https://plycdn.com/app.
- Open Content search → Indexing settings.
- Change the callback URL from
https://YOUR_BACKEND/api/proctored-content/v1/source-callbacktohttps://YOUR_BACKEND/api/plycdn-content/v1/source-callback. - Save. The callback secret does not change.
If your organization has sub-organizations with their own storage settings, repeat this for each of them, using the organization menu in the top bar of the dashboard.
Storage (for highlighted PDFs)
In 1.6, a PDF result opens inside the component at the matched page, with the passage highlighted and the searched words marked. To do that, the browser reads the PDF directly, so your storage must allow cross-origin reads from your application, as it already does for Word and Excel files:
- For Azure Blob Storage, add a CORS rule for each origin your application is served from:
allow
GETandHEAD, and exposeContent-LengthandContent-Range. - If your files are read through your own domain (your Application Gateway, via
PublicReadBaseUrl), there is nothing to add: the browser reads them from its own origin.
Without the rule, nothing breaks: PDFs open in the browser's own viewer at the right page, just without the highlighting. No Content-Security-Policy change is needed for 1.6.
Storage event subscriptions
Only if you connected storage under Content search → Storage connectors and set up event notifications (for example Azure
Event Grid). Open each connector in the dashboard, copy its notification address, which now begins
https://api.plycdn.com/, and update the endpoint of your event subscription. The previous address
keeps working in the meantime.
Check it works
- Sign-in and search: in your application, search for something you know is in your library. Results appear as one card per file.
- Playback: open a video result. It plays from the matched moment ("Play from 2:14").
- Documents: open a PDF result. It opens at the matched page, with the passage highlighted (after step 4).
- Upload: upload a small file. It reaches Ready to search in your application and Ready in the dashboard Library.
- Callback address: in the dashboard Library, open any file and press Re-index in the file's header (it is also in the row's menu in the list). It reaches Ready only by reading the file through your callback, so this confirms step 3.
If any step fails, the dashboard's Content search → Library health page shows what went wrong with each file, and the error code on a failed request matches the table in the API reference.
What else 1.6 brings
- One result per file, with jump-to links for every match (time, page or slide).
- The words you searched for are marked in results and inside opened documents.
- PDFs render in place with the matched passage highlighted.
- The result button says where it goes: "Play from 2:14", "Go to page 4", "Go to slide 3".
- SCORM packages of every common shape are read, including slide-player courses whose content is in a data file, and launch pages that navigate between lesson pages.
If you need to go back
Reinstall your previous packages and set the callback URL (step 3) back to the old route. Your data is unaffected either way. The previous address stays available until we agree a date with you to retire it.
3Content Search: moving to 1.7
This release changed usage and billing, and has nothing to do with the rebrand above. The usage and billing changes below need no code change to keep working; the removals in the last bullet do, if you used what was removed.
- .NET: no existing property changed type or name. Where an amount was a
double?, it still is. New…Decimalproperties (AmountDecimal,QuantityDecimal,IncludedDecimal,BillableDecimal,UnitPriceDecimal,TotalDecimal) sit alongside them for exact money and quantities; prefer those in new code. Thedouble?ones are marked obsolete in their XML documentation only — no[Obsolete]attribute, so a build that treats warnings as errors is unaffected. tois now inclusive.from=2026-09-01&to=2026-09-30covers all of September. If your code requestedtoone day past what it wanted (to work around the old, exclusive behaviour), remove that adjustment.dailyBudgetUsdis ignored. It is still accepted onPUT /settingsand still returned byGET /settings, always as0, for wire compatibility. What an organization can use is now controlled by your plan's quotas (GetUsageQuotasAsync/GET /usage/quotas), not a cost figure. Remove any code that reads or sets it for a real effect.- Sub-organization usage rolls up to the parent. Your account gets one statement, one allowance
and one monthly minimum, covering every sub-organization;
GetUsageAsyncon the parent's key now returns anOrganizationsbreakdown alongside the account total. - New
month=request form.GetUsageAsync(org, year, month)reads a whole calendar month directly, in your account's time zone, without you computingfrom/toyourself. - Removed, and what to use instead. Renewing source access and reading settings are server
actions only. Angular:
ContentClient.refreshSourceandContentUploadComponent.renewSourceare gone (the upload row's Check again asks for access, and your server renews it through the source-access callback). .NET:ContentController.RefreshSourceandContentController.Settingsare gone, with the browser routesassets/{id}/refresh-sourceandsettings; read settings on your server withGetSettingsAsync. Also, a plycdn API key in a URL or request body, deprecated in 1.7, is refused from 1.9: send it in theAuthorization: ApiKeyheader. The Release notes list every removal since 1.6. - New:
GetUsageDailyAsync,GetUsageQuotasAsync,ListStatementsAsync,GetStatementAsyncandExportStatementCsvAsync— see "How usage is counted" in the Integration guide and "What you have used" in the API reference.
For help at any step, contact your plycdn representative.