ECMWF Sites — End‑user documentation¶

This is the end-user documentation for the ECMWF Sites service.

It’s written for:

• Site owners (people who create and maintain a site)
• Site admins (people who can manage a site’s settings and access)
• Contributors (people who upload/publish content)
• Automation users (CI pipelines, scripts)

It avoids Kubernetes and internal implementation details wherever possible.

Start here¶

• 01-what-is-sites.md — what the service is and when to use it
• 02-getting-started.md — create your first site, find the URLs, and browse listings
• 03-managing-access.md — private/public, groups, admins, tokens

Publishing content¶

Pick the workflow that fits you:

• 04-publishing-content.md — overview of ways to publish
• Sites CLI and Sites SDK — tools for command-line and Python publishing workflows
• 05-site-api-cookbook.md — practical API examples: list, download, verify, upload (full, multipart, resumable), directories, bulk delete, archives, browser CORS
• Signed and session URLs for safe sharing — create and use both types of temporary sharing links
• 07-webdav-and-s3.md — optional interfaces (if enabled for your site)

Operating your site¶

• 08-site-settings.md — site identity, access, tokens, headers, applications, storage, and lifecycle settings
• 12-custom-applications.md — run your own container image as your site
• 09-day-2-operations.md — restart/upgrade, health checks, logs
• 10-troubleshooting.md — common problems and fixes

Reference (for users)¶

• 11-glossary.md
• 13-understanding-urls.md — every URL path type, with examples and when to use each

Where API reference lives¶

Use the live OpenAPI reference for the service that you use:

• Hub API: open /hub/api/v2/spec/ on your Sites service.
• Site API: open the Open API URL in the site's Overview in the Hub. This specification includes the operations available for that site.

This guide explains common tasks. The live OpenAPI specifications are the authoritative reference for endpoint details.