Update workspace | neoserver docs

PUT /api/v1/workspaces/{workspace}

Updates a workspace. Requires admin access to the workspace. Omitted or null description leaves it unchanged; an empty string clears it.

Operation ID: updateWorkspace

Authentication

Use one of the following authentication options. Permissions and workspace scope still apply. See authentication and access control.

Authorization: Bearer YOUR_ACCESS_TOKEN
X-API-Key: YOUR_API_KEY

Parameters

workspace path required: Workspace ID

string

Request body

Required

Workspace updates

Content type application/json

object

description string

Nullable: true

name string

Responses

200 Updated workspace

Content type application/json

Workspace ↗

400 Bad Request

Content type application/json

Error ↗

401 Unauthorized

Content type application/json

Error ↗

403 Forbidden

Content type application/json

Error ↗

404 Workspace not found

Content type application/json

Error ↗

409 A workspace with this name already exists

Content type application/json

Error ↗

413 Request body exceeds the configured limit

Content type application/json

Error ↗

426 HTTPS required

Content type application/json

Error ↗

429 Request rate exceeded

Content type application/json

Error ↗

503 Service temporarily unavailable

Content type application/json

Error ↗

OpenAPI operation definition

{
  "description": "Updates a workspace. Requires admin access to the workspace. Omitted or null description leaves it unchanged; an empty string clears it.",
  "operationId": "updateWorkspace",
  "parameters": [
    {
      "description": "Workspace ID",
      "in": "path",
      "name": "workspace",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "properties": {
            "description": {
              "nullable": true,
              "type": "string"
            },
            "name": {
              "type": "string"
            }
          },
          "type": "object"
        }
      }
    },
    "description": "Workspace updates",
    "required": true
  },
  "responses": {
    "200": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Workspace"
          }
        }
      },
      "description": "Updated workspace"
    },
    "400": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Bad Request"
    },
    "401": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Unauthorized"
    },
    "403": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Forbidden"
    },
    "404": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Workspace not found"
    },
    "409": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "A workspace with this name already exists"
    },
    "413": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request body exceeds the configured limit"
    },
    "426": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "HTTPS required"
    },
    "429": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Request rate exceeded"
    },
    "503": {
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      },
      "description": "Service temporarily unavailable"
    }
  },
  "summary": "Update workspace",
  "tags": [
    "Workspaces"
  ]
}