Skip to content

Document the new ExportBlueprint/ImportBlueprint APIs (2026.1) - #22

Merged
nahumtimerman merged 1 commit into
mainfrom
docs/export-import-blueprint-api
Sep 9, 2026
Merged

nahumtimerman merged 1 commit into
mainfrom
docs/export-import-blueprint-api

Conversation

@nahumtimerman

Copy link
Copy Markdown
Collaborator

Adds a how-to page under DevGuide > CloudShell Automation API > Useful Code Examples for the new ExportBlueprint / ImportBlueprint Automation API methods introduced in CloudShell 2026.1.

The page covers:

  • What the APIs are for: version-controlling blueprint definitions, promoting blueprints between servers, scripted backup.
  • ExportBlueprint — parameters, response shape (Blueprints list of Name/Xml), domain scoping, deterministic output.
  • ImportBlueprint — create-or-update semantics, hard failure when a referenced family/model/attribute/script/driver/category is missing on the target, the active-draft block, and the fact it is deliberately not admin-gated.
  • A runnable Python example (export to file → import into another server) based on the integration-test script.

Grounded in the server implementation (ResourceAPIApplicationService), the Testegator packaging scenarios, and the python-api integration scenario. Also adds the three new API names to the spellcheck wordlist.

🤖 Generated with Claude Code

Adds a how-to for exporting a blueprint as its definition XML and importing
it back - version control, cross-server promotion, backup. Grounded in the
server implementation and the packaging/python-api integration scenarios.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@nahumtimerman
nahumtimerman merged commit 692371d into main Sep 9, 2026
1 check passed
@nahumtimerman
nahumtimerman deleted the docs/export-import-blueprint-api branch September 9, 2026 10:34
nahumtimerman added a commit that referenced this pull request Sep 9, 2026
…silience, SAML XXE, bug fixes

Closes out the catch-up for everything that landed on 2026.1 after
2026.1.0.52.

PreserveDiagramLayoutOnViewStyleChange (CS 189995/189996/190004, ticket 67465
/ WI 19310). Documented as a customer key on the Portal - it is declared
AppSettingVisibility.Customer, unlike the ES/Server keys below - with the
overlap caveat from the setting's own description. The three unconditional
coordinate fixes (Arrange, drag-to-move, sticky-note resize) are noted
separately, since they apply whether or not the key is set.

Linux/Mono ES resilience (CS 189890/189891, ticket 67293). Described by
behavior rather than by key: MinThreadPoolWorkerThreads (200),
BeginExecutionMaxRetryCount (10) and BeginExecutionRetryIntervalSec (6) all
default to AppSettingVisibility.Support, so they do not belong in the customer
configuration keys repository. The user-visible facts are the wedged agent
under driver-spawn bursts, the ~100s dispatch tolerance, and the Linux venv
bin-vs-Scripts path fix.

SAML ACS XXE (CS 189894, CWE-611) added to Security Updates - unauthenticated
endpoint, so it is called out for SSO/SAML deployments.

Bug fixes: diagram duplicate resource alias (CS 189961, release note),
'Blueprint not found' loop on domain switch (CS 189991), 500 downloading a
shell or provisioning script with an extensionless stored file name
(CS 189989), Properties dialog end time for a non-admin on an extended
sandbox (CS 190005).

Deliberately not documented: the Docker ES get-pip curl/wget change
(CS 189983/189984/189986) is image build plumbing that never reached a
released image, plus Dotfuscator, TCL/XmlToHtml generation, nightly-red and
CI-only changesets. ExportBlueprintPackage/ImportBlueprintPackage
(CS 189912/189917/189921) are also omitted: CS 189940 replaced them with the
ExportBlueprint/ImportBlueprint pair already documented in #22.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
nahumtimerman added a commit that referenced this pull request Sep 10, 2026
…inputs, category validation (#24)

Documents the three behavior-changing items that landed on 2026.1 after the
2026.1.0.52 pass (#18) and were not covered by #19-#22.

Python 3 upgraded to 3.13.15 x64 (Trunk CS 189988/189997/189999, backported
in CS 190003). This is the WINDOWS bundled slot only - the Docker ES image
still builds Python 3.9.9, and so do the Linux VA and the from-script ES, so
every page states the platform split rather than a blanket "CloudShell now
uses 3.13". Python 2.7.18 is untouched. Also corrects setting-up-dev-env.md,
which #23 had just updated to say the bundled version is 3.9.9 - true when
it merged on Sep 6, wrong when the upgrade landed on Sep 8.

Global inputs kept on save as blueprint, with the new
KeepResourceGlobalInputsOnSaveAsBlueprint key (CS 189903/189905/189914).
Default is true, which is a behavior change on upgrade: inputs that fronted a
resource requirement used to be dropped and are now visible in the Reserve
dialog and the blueprint editor. Documented as a customer-visible key on the
Server (AppSettingVisibility.Customer, read by ServiceConfigSettingsLoader).

Blueprint import now fails on a category missing from the target domain
instead of silently dropping the association (CS 189942). The
ExportBlueprint/ImportBlueprint page from #22 already stated this, so it
needed no correction - only the release notes did.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
nahumtimerman added a commit that referenced this pull request Sep 10, 2026
…silience, SAML XXE, bug fixes

Closes out the catch-up for everything that landed on 2026.1 after
2026.1.0.52.

PreserveDiagramLayoutOnViewStyleChange (CS 189995/189996/190004, ticket 67465
/ WI 19310). Documented as a customer key on the Portal - it is declared
AppSettingVisibility.Customer, unlike the ES/Server keys below - with the
overlap caveat taken from the setting's own description. The three
unconditional coordinate fixes (Arrange, drag-to-move, sticky-note resize)
are noted separately, since they apply whether or not the key is set.

Linux/Mono ES resilience (CS 189890/189891, ticket 67293). Described by
behavior rather than by key: MinThreadPoolWorkerThreads (200),
BeginExecutionMaxRetryCount (10) and BeginExecutionRetryIntervalSec (6) all
take the AppSetting constructor default of AppSettingVisibility.Support, so
they do not belong in the customer configuration keys repository. The
user-visible facts are the wedged agent under driver-spawn bursts, the ~100s
dispatch tolerance, and the Linux venv bin-vs-Scripts path fix.

SAML ACS XXE (CS 189894, CWE-611) added to Security Updates - the endpoint is
reachable unauthenticated, so it is called out for SSO/SAML deployments.

Bug fixes: diagram duplicate resource alias (CS 189961, release note),
'Blueprint not found' loop on domain switch (CS 189991), 500 downloading a
shell or provisioning script with an extensionless stored file name
(CS 189989), Properties dialog end time for a non-admin on an extended
sandbox (CS 190005).

Deliberately not documented: the Docker ES get-pip curl/wget change
(CS 189983/189984/189986) is image build plumbing whose failing builds never
shipped, plus Dotfuscator, TCL/XmlToHtml generation, nightly-red and CI-only
changesets. ExportBlueprintPackage/ImportBlueprintPackage
(CS 189912/189917/189921) are also omitted: CS 189940 replaced them with the
ExportBlueprint/ImportBlueprint pair documented in #22.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
nahumtimerman added a commit that referenced this pull request Sep 10, 2026
…silience, SAML XXE, bug fixes (#28)

Closes out the catch-up for everything that landed on 2026.1 after
2026.1.0.52.

PreserveDiagramLayoutOnViewStyleChange (CS 189995/189996/190004, ticket 67465
/ WI 19310). Documented as a customer key on the Portal - it is declared
AppSettingVisibility.Customer, unlike the ES/Server keys below - with the
overlap caveat taken from the setting's own description. The three
unconditional coordinate fixes (Arrange, drag-to-move, sticky-note resize)
are noted separately, since they apply whether or not the key is set.

Linux/Mono ES resilience (CS 189890/189891, ticket 67293). Described by
behavior rather than by key: MinThreadPoolWorkerThreads (200),
BeginExecutionMaxRetryCount (10) and BeginExecutionRetryIntervalSec (6) all
take the AppSetting constructor default of AppSettingVisibility.Support, so
they do not belong in the customer configuration keys repository. The
user-visible facts are the wedged agent under driver-spawn bursts, the ~100s
dispatch tolerance, and the Linux venv bin-vs-Scripts path fix.

SAML ACS XXE (CS 189894, CWE-611) added to Security Updates - the endpoint is
reachable unauthenticated, so it is called out for SSO/SAML deployments.

Bug fixes: diagram duplicate resource alias (CS 189961, release note),
'Blueprint not found' loop on domain switch (CS 189991), 500 downloading a
shell or provisioning script with an extensionless stored file name
(CS 189989), Properties dialog end time for a non-admin on an extended
sandbox (CS 190005).

Deliberately not documented: the Docker ES get-pip curl/wget change
(CS 189983/189984/189986) is image build plumbing whose failing builds never
shipped, plus Dotfuscator, TCL/XmlToHtml generation, nightly-red and CI-only
changesets. ExportBlueprintPackage/ImportBlueprintPackage
(CS 189912/189917/189921) are also omitted: CS 189940 replaced them with the
ExportBlueprint/ImportBlueprint pair documented in #22.

Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant