Skip to content
Nokku LogoNokku
API Referencev1.0.0 · 174 endpoints

nokku.v1.GetWorkspaceResponse

object
nokku.v1.GetWorkspaceResponse
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 <date-time>

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 <date-time>

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>
baseUrl?
string
inactive?
boolean

inactive is a hosted workspace with no trial or plan. It signs no user certificates until the owner activates a license key.

deleteAt?
string <date-time>

delete_at is when an inactive workspace is deleted, unless the owner activates a license key before.

features?
object

features is what every member may see, so any page can show a lock. GetBilling has the rest.

Map value

[key: string]?
boolean
catalog?
array<nokku.v1.PlanFeature>

catalog names every feature and the smallest plan that has it. It is the same for every workspace.

planNames?
object

plan_names are the names people see, by plan code.

Map value

[key: string]?
string

Example

{
  "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"
    ]
  },
  "baseUrl": "string",
  "inactive": true,
  "deleteAt": "2023-01-15T01:30:15.01Z",
  "features": {
    "property1": true,
    "property2": true
  },
  "catalog": [
    {
      "key": "string",
      "label": "string",
      "plan": "string"
    }
  ],
  "planNames": {
    "property1": "string",
    "property2": "string"
  }
}