Skip to main content

Update Domain

Request

This API provides capability to update user's Domain

Security
BearerAuth
Path
appDomainIdstring, (uuid)required

App Domain UUID

Example:20f3ef8e-d670-4236-86fa-bb0038adcfc3
Bodyapplication/json-patch+jsonrequired
Array [
opstringrequired

operation type applied to the resource

Enum:"replace""add""remove"
pathstringrequired

path inside document leading to updated parameter

Value:"/description"
valueanyrequired

new value for updated parameter

]
Payload
[ { "op": "replace", "path": "/description", "value": "Updated Atlassian Domain" } ]

Responses

App Domain object

Bodyapplication/json
hrefstring, (uri)read-only

Resource URI

Example:"https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3"
typestring(AppDomainType)required

App Domain Type

Default:"APP_DOMAIN"
Value:"APP_DOMAIN"
Example:"APP_DOMAIN"
uuidstring, (uuid)

Equinix-assigned access point identifier

Example:"20f3ef8e-d670-4236-86fa-bb0038adcfc3"
namestring, (string)required

Customer-provided App Domain name

Example:"atlassian.net"
descriptionstring, (string)

Customer-provided App Domain description

Example:"Atlassian Domain"
statestring, (string)(AppDomainState)

App Domain lifecycle state

Enum:"PENDING_VERIFICATION""PROVISIONING_FAILED""PROVISIONED""DEPROVISIONING""DEPROVISIONING_FAILED""DEPROVISIONED"
Example:"PENDING_VERIFICATION"
projectobject(Project)required
changeLogobject(Changelog)

Change log

changeobject(AppDomainChange)

Current state of latest AppDomain change

Response
{ "href": "https://api.equinix.com/fabric/v4/appDomains/20f3ef8e-d670-4236-86fa-bb0038adcfc3", "uuid": "20f3ef8e-d670-4236-86fa-bb0038adcfc3", "type": "APP_DOMAIN", "name": "atlassian.net", "description": "Updated Atlassian Domain", "state": "PROVISIONED", "project": { "projectId": "71b55fef-fd2e-402f-ae3c-01d5f00bf2d4" }, "change": { "uuid": "531c4ab5-43b0-4352-8975-ee9045325841", "type": "APP_DOMAIN_UPDATE", "status": "REQUESTED", "createdDateTime": "2026-06-27T04:20:55.471Z", "updatedDateTime": "2026-06-28T04:20:55.471Z", "data": [ … ] }, "changeLog": { "createdBy": "test", "createdDateTime": "2026-06-27T04:20:55.471Z", "updatedBy": "test", "updatedDateTime": "2026-06-28T04:20:55.471Z" } }
Was this page helpful?