Update workspace name

Renames a workspace to a new name specified in the name parameter.

Validation:

• The name cannot be empty
• Must be unique for the user within the repository
• Cannot exceed 256 characters

Requirements: Requires READ access to the repository.

Returns:

• 400 Bad Request if the name is invalid (empty or exceeds 256 characters)
• 409 Conflict if a workspace with the new name already exists
• 204 No Content on success

POST /repos/{repo_id}/workspaces/{workspace_id}/rename

Update workspace name

cURL

curl --request POST \
  --url https://api.diversion.dev/v0/repos/{repo_id}/workspaces/{workspace_id}/rename \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'

409

{
  "status": 403,
  "detail": "User not authorized to perform the requested action on the resource",
  "title": "<string>",
  "type": "<string>"
}

Authorizations

Authorization · string · header · required

This API uses OAuth 2 with the implicit grant flow

Path Parameters

repo_id · string · required

The repo ID of the repository. Repo name can be used instead of the ID, but usage of ID for permanent linking and API requests is preferred.

Required string length: 3 - 128

Example:

"example_id"

workspace_id · string · required

The repo ID of the workspace.

Required string length: 3 - 128

Example:

"example_id"

Body

application/json

Properties to modify in an existing workspace

name · string · required

A name to set for the workspace

Minimum string length: 1

Response

204

Request completed successfully