Skip to content
CM Box Documentation

Update a site

PUT
/api/sites/{id}
curl --request PUT \
  --url https://example.com/api/sites/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "url": "example", "repositories": [ "example" ], "readPerm": [ "example" ], "writePerm": [ "example" ], "deletePerm": [ "example" ] }'

Updates an existing site

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

Site ID

string

Request Body

Section titled “Request Body”
Media typeapplication/json
object
name

Updated site name

string
description

Updated description

string
url

Updated site URL

string
repositories

Updated repository IDs

Array<string>
readPerm

Roles with read permission

Array<string>
writePerm

Roles with write permission

Array<string>
deletePerm

Roles with delete permission

Array<string>
Examplegenerated
{
  "name": "example",
  "description": "example",
  "url": "example",
  "repositories": [
    "example"
  ],
  "readPerm": [
    "example"
  ],
  "writePerm": [
    "example"
  ],
  "deletePerm": [
    "example"
  ]
}

Responses

Section titled “Responses”

200

Section titled “200”

Site updated successfully

Media typeapplication/json
object
id
required

Site ID

string
name
required

Site name

string
description

Site description

string
url

Site URL

string
repositories

Connected repository IDs

Array<string>
createdAt

Creation timestamp

number
updatedAt

Last update timestamp

number
readPerm

Roles with read permission

Array<string>
default:
writePerm

Roles with write permission

Array<string>
default:
deletePerm

Roles with delete permission

Array<string>
default:
Example
{
  "id": "site-123",
  "name": "Marketing Site",
  "url": "https://example.com",
  "readPerm": [],
  "writePerm": [],
  "deletePerm": []
}