Accessibility Agent3

Accessibility Checker4

Administration10

AI27

Announcements1

API Token7

Apps12

Authentication6

Browser Tree5

Bulk Upload1

Bundle16

Cache Management11

Categories10

Cluster Management5

Containers21

Content20

Content Analytics3

Content Delivery8

Content Import12

Content Report2

Content Type11

Content Type Field36

Data Integrity8

dotAuth15

Elasticsearch Content Search3

Environment11

Experiment18

File Assets5

Folders8

Forms1

getPagesContentTypes1

Health8

Internationalization14

JavaScript18

Job Queue14

Language2

License8

Maintenance26

Navigation2

Notifications5

OSGi Plugins15

Page18

Permissions11

Personalization4

Personas2

Portlets14

Publishing16

Relationships2

Roles19

Rules Engine26

SAML Authentication5

Search Index19

Site20

System10

System Configuration23

System Logging3

System Monitoring2

System Storage2

Tag (v1)10

Tags13

TailLog2

Template14

Templates18

Temporary Files2

Theme2

Usage1

Users13

Variants5

Web Assets9

Widgets1

Workflow57

Site

Update an existing site

Changed on Oct 30, 2026

Updates the properties of an existing site. The site to update is identified by the 'id' query parameter (also referred to as 'siteId' or 'hostId' in other parts of the API). Requires access to the Sites portlet.

put/api/v1/site

Request

Base URL
https://docs.anzworldline-solutions.com.au
Auth
none declared
TypeScript
https://skmtc.dev/anzworldline-solutions/apis/dotcms-rest-api/docs/api/v1/site/put.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

idstring required

Identifier of the site to update (siteId/hostId are used interchangeably)

Request body

aliasesstring

Comma- or newline-separated list of host aliases (alternate hostnames) for this site.

siteNamestring required

The hostname of the site, e.g. 'www.example.com'. This is the site's primary name.

tagStoragestring

Identifier of the site whose tag storage this site shares. Defaults to this site itself when omitted.

siteThumbnailstring

Identifier of the image asset used as the site thumbnail.

runDashboardboolean

Whether the analytics dashboard runs for this site.

keywordsstring

Default meta keywords applied to pages on this site.

descriptionstring

Default meta description applied to pages on this site.

googleMapstring

Google Maps API key for this site.

googleAnalyticsstring

Google Analytics tracking ID for this site.

addThisstring

AddThis sharing-widget account ID for this site.

proxyUrlForEditModestring

Proxy URL used to render the site in edit mode.

embeddedDashboardstring

Embedded dashboard markup for this site.

languageIdinteger

Default language ID for this site. Defaults to the system default language when 0/omitted.

identifierstring

Identifier of the site. Ignored on creation; server-generated.

inodestring

Inode (version identifier) of the site. Ignored on creation; server-generated.

defaultboolean

forceExecutionboolean

Whether to force creation even when validation would otherwise warn (e.g. a duplicate alias).

Response

Site updated successfully

entityobject

i18nMessagesMapobject

permissionsstring[]

Changes

Oct 30, 20264fd8e917d458 Revision changes
- breaking
  request body became required
- breaking
  removed the media type */* from the request body
- breaking
  the query request parameter id became required
- info
  api tag Site added
- info
  added the media type application/json to the request body
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the success response with the status

Operation history