What is the Site UUID

A Site UUID (Universally Unique Identifier) in the context of an API is a unique, permanent identifier assigned to a specific website, environment, or project within a system. Here’s what that means in simple terms:

What a Site UUID Is:

• It’s a string of characters (e.g., f1a23b45-678c-90de-f123-456789abcde0) that uniquely identifies one site or environment.

• It never changes, even if the site name, domain, or settings do.

• It is generated automatically by ShowOff & can be viewed by selecting the cog icon at the top of your CMS

What It Does for an API:

1. Identifies which site you're interacting with

When you make an API request (e.g., fetching content, updating a record, or authenticating), the platform needs to know which site the request refers to.
The Site UUID acts as a fixed, unique reference.

Example:

GET /api/content?site_uuid=f1a23b45-678c-90de-f123-456789abcde0

2. Prevents confusion when sites have similar names:

You might have:

• Production site

• Staging site

• Development site

All might be called “My Website”, but each gets a different UUID so the API knows exactly which one you mean.

3. Helps with security and validation:

Some APIs require the Site UUID to validate:

• The request is coming from a known site

• The API key/token has permission to access that site

This prevents requests from unauthorised or unknown installations.

4. Used for syncing or migrating data:

Platforms like ShowOff use the Site UUID when:

• Syncing configuration

• Exporting/importing content

• Ensuring that configs are only applied to the correct site

It stops you from accidentally importing data meant for a different environment.

5. Used internally by systems for tracking:

The API may use the UUID to:

• Log activity

• Monitor usage

• Track analytics per site

• Manage billing or quotas

In Summary:

A Site UUID is a permanent, unique fingerprint for a site.
For an API, it ensures that requests, data, and permissions apply to the correct site, even if other details change.