# UpdateWorkspace

`POST /nokku.v1.WorkspaceService/UpdateWorkspace`

UpdateWorkspace

Base URL: https://app.nokku.sh

## Authorization

- BearerAuth: HTTP bearer
- CookieAuth: API key in cookie `__Host-nokku_session`

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Connect-Protocol-Version` | header | number | no | Define the version of the Connect protocol |
| `Connect-Timeout-Ms` | header | number | no | Define the timeout, in ms |

## Request body (application/json, required)

- `name` (string)
- `description` (string)
- `settings` (object)
  - `defaultDaemonConfig` (object)
    - `recordSessions` (boolean)
    - `allowForwarding` (boolean)
    - `allowAgentForwarding` (boolean)
    - `gatewayPorts` (boolean)
    - `ephemeral` (boolean)
    - `idleTimeout` (string): idle_timeout closes an interactive session nobody typed into for that long. It is the workspace's session_idle_timeout, filled in by the core on sync and ignored when sent.
  - `enforceSso` (boolean)
  - `sessionIdleTimeout` (string): duration.gte = 0s duration.lte = 86400s
- `updateMask` (string, required): field_mask.in = ["name", "description", "settings.enforce_sso"]

Example:

```json
{
  "name": "string",
  "description": "string",
  "settings": {
    "defaultDaemonConfig": {
      "recordSessions": true,
      "allowForwarding": true,
      "allowAgentForwarding": true,
      "gatewayPorts": true,
      "ephemeral": true,
      "idleTimeout": "string"
    },
    "enforceSso": true,
    "sessionIdleTimeout": "string"
  },
  "updateMask": "string"
}
```

## Responses

### 200: Success

Returns `nokku.v1.UpdateWorkspaceResponse`.

- `workspace` (object)
  - `id` (string)
  - `slug` (string)
  - `name` (string)
  - `description` (string)
  - `settings` (object)
    - `defaultDaemonConfig` (object)
      - `recordSessions` (boolean)
      - `allowForwarding` (boolean)
      - `allowAgentForwarding` (boolean)
      - `gatewayPorts` (boolean)
      - `ephemeral` (boolean)
      - `idleTimeout` (string): idle_timeout closes an interactive session nobody typed into for that long. It is the workspace's session_idle_timeout, filled in by the core on sync and ignored when sent.
    - `enforceSso` (boolean)
    - `sessionIdleTimeout` (string): duration.gte = 0s duration.lte = 86400s
  - `createdAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `updatedAt` (string): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC.
  - `requestableTags` (array<string>)

```json
{
  "workspace": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "settings": {
      "defaultDaemonConfig": {
        "recordSessions": true,
        "allowForwarding": true,
        "allowAgentForwarding": true,
        "gatewayPorts": true,
        "ephemeral": true,
        "idleTimeout": "string"
      },
      "enforceSso": true,
      "sessionIdleTimeout": "string"
    },
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z",
    "requestableTags": [
      "string"
    ]
  }
}
```

### default: Error

Returns `connect.error`.

- `code` (string): The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. One of: `canceled`, `unknown`, `invalid_argument`, `deadline_exceeded`, `not_found`, `already_exists`, `permission_denied`, `resource_exhausted`, `failed_precondition`, `aborted`, `out_of_range`, `unimplemented`, `internal`, `unavailable`, `data_loss`, `unauthenticated`.
- `message` (string): A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.
- `details` (array<connect.error_details.Any>): A list of messages that carry the error details. There is no limit on the number of messages.

```json
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}
```

## Example request

```bash
curl -X POST 'https://app.nokku.sh/nokku.v1.WorkspaceService/UpdateWorkspace' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "settings": {
    "defaultDaemonConfig": {
      "recordSessions": true,
      "allowForwarding": true,
      "allowAgentForwarding": true,
      "gatewayPorts": true,
      "ephemeral": true,
      "idleTimeout": "string"
    },
    "enforceSso": true,
    "sessionIdleTimeout": "string"
  },
  "updateMask": "string"
}'
```
