Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,090 of 9,090 pages
About the help in other languages
All help pages

Stable URLs for datasets

How to give every dataset an address that keeps working for years: what Exponential does automatically after renames and moves, what breaks an address, and the rules a data team should agree on.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/government/open-data/stable-urls-for-datasets.md

On this page

Stable URLs for datasets

This page is for website creators, editors and administrators who publish data that other people will link to, download by script or cite. Re-users build on your addresses; a broken one breaks their work. The facts about aliases and redirects come from Redirects and moved content and URL aliases and nice URLs.

Contents

  1. The addresses a dataset has
  2. What Exponential keeps working
  3. What breaks an address
  4. Rules for the data team
  5. A short, permanent address per dataset
  6. Checking addresses

The addresses a dataset has

AddressExampleStable while
URL alias of the page/Open-data/Street-lighting-requeststhe node exists; old aliases redirect after a rename or move
System address of the node/content/view/full/<node ID>the node exists
Download of a file/content/download/<object ID>/<attribute ID>/file/<file name>the object exists and the file name stays
Feed of the catalog/rss/feed/<address>the RSS export exists and is active
REST address/api/ezp/v1/content/node/<node ID>the node exists and the API stays enabled

The node ID and object ID never change for the life of the object, whatever editors do with names and places.

What Exponential keeps working

EventResult
The page is renameda new alias is made; the old one stays and redirects
The page is movedthe old path redirects
A translation is renamedthe same, per language
The file is replaced with one of the same namethe download address stays the same

So editors can correct titles and reorganize folders without breaking links.

What breaks an address

EventResultPrevention
The node is removed"not found"; nothing redirectsDo not remove datasets; mark them withdrawn (see "Versioning and updating datasets")
The file is replaced with one of another namethe old download address no longer matchesKeep file names stable, or link to the page
The catalog moves to another siteaccess or hostaddresses on the old host stopRedirect in the web server (Going live)
A global alias or wildcard is removedits address stopsKeep a list of the aliases you promised

Rules for the data team

  1. Link to the dataset page, not to a file, in announcements and catalogs.
  2. Never remove a published dataset; withdraw it with a notice instead.
  3. Keep file names stable across updates, or publish each period as its own distribution.
  4. Give every dataset a short, permanent alias (below) and print it on the page as "Cite as".
  5. Record moved or retired addresses in a redirect table before a relaunch (Relaunching a site: a redirect plan).

A short, permanent address per dataset

Give each dataset an extra alias such as /data/street-lighting:

  1. Open the dataset page, the URL aliases tab.
  2. Add the alias. It points to the node, so it keeps working through renames and moves.

For a pattern of old addresses, use Setup > URL wildcards (for example datasets/* to data/{1}), with "Redirecting URL" checked, and test it with Try an address (URL wildcards).

Checking addresses

  • curl -sI https://www.example.gov/data/street-lighting should answer 200, or 301 to the current page.
  • Setup > Link management lists links in your content and their state (Link list).
  • ./console exp:verify_aliases checks the URL alias table; --fix repairs what is safe to repair (Content languages, section 10).

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x