Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add operator note: populate SolutionCenterApi.PublicBaseUrls so OpenAPI servers[] is populated for external SDK consumers.

...

Method

URL

Scope

Purpose

GET

/api/v1/files/allowed-paths

installation:files

Returns the active path allowlist.

GETPOST

/api/v1/files/existsallowed-paths

installation:filesadmin

Existence check for a file or directory under the allowlist.

Add a search path to the persistent allowlist. Body: { "path": "..." }. Idempotent — re-adding an existing path is a no-op. Returns 200 with { "path": "...", "status": "added" }.

DELETEPOST

/api/v1/files/upload/startallowed-paths

installation:filesadmin

Begin a chunked upload; returns a transfer ID.

POST

/api/v1/files/upload/chunk

installation:files

Upload one chunk of an in-progress transfer.

Remove a search path from the persistent allowlist. Body: { "path": "..." } (path is in the body, not the URL, to mirror the POST shape and avoid URL-encoding hell with Windows paths). Idempotent — removing a path not in the list still returns 200 with { "path": "...", "status": "removed" }.

GET

POST

/api/v1/files/upload/finishexists

installation:files

Finalize a chunked uploadExistence check for a file or directory under the allowlist.

POST

/api/v1/files/upload/cancelstart

installation:files

Cancel an in-progress Begin a chunked upload; returns a transfer ID.

POST

/api/v1/files/upload/chunk

installation:files

Upload one chunk of an in-progress transfer.

POST

/api/v1/files/upload/finish

installation:files

Finalize a chunked upload.

POST

/api/v1/files/upload/cancel

installation:files

Cancel an in-progress chunked upload.

POST

/api/v1/files/upload/small

installation:files

Single-shot upload for files under 4 MB.

POST

/api/v1/files/download/start

installation:files

Begin a chunked download; returns a transfer ID.

POST

/api/v1/files/download/chunk

installation:files

Read one chunk of an in-progress download.

POST

/api/v1/files/download/finish

installation:files

Finalize a chunked download.

POST

/api/v1/files/download/cancel

installation:files

Cancel an in-progress chunked download.

GET

/api/v1/files/download/size

installation:files

Pre-flight size check for a downloadable file.

POST

/api/v1/files/delete-solution

installation:admin

Delete a solution from the installation. Privileged.

...

The OpenAPI endpoint stays reachable even when the activation gate is OFF, so downstream tooling can introspect the surface before operators flip the gate.

The OpenAPI document advertises base URLs via its servers[] array. By default this array is empty — client generators and Swagger UI then fall back to the host that served the document, which is correct in most local-network deployments. If the OpenAPI document will be consumed away from the API host (developer portals, partner SDK distributions, or reverse-proxy fronts where the externally-reachable hostname differs from the listener), populate SolutionCenterApi.PublicBaseUrls in TWebServices.json with the canonical external URL(s) — one entry per URL — so generated clients and rendered docs target the right host.

What is not in v1 (reserved for v2)

...