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

GetWorkspace

nokku.v1.WorkspaceService
POST
https://app.nokku.sh/nokku.v1.WorkspaceService/GetWorkspace
Try it
Authorization (BearerAuth)

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Example 1
Connect-Timeout-Ms?number

Define the timeout, in ms

Example 1000

Authorization

  • BearerAuth (bearer)

    A service account token. Include it in the Authorization header: `Authorization: Bearer <token>`

  • CookieAuth (cookie: __Host-nokku_session)

    The session cookie the web app uses. Browsers send it after sign-in. Only on `localhost` it is named `nokku_session`.

Request Body

Required

application/json

nokku.v1.GetWorkspaceRequest

Responses

200

Success

application/json

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
default

Error

application/json

connect.error

Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation

code?
string

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

Enum:"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.

Code Samples

curl -X POST 'https://app.nokku.sh/nokku.v1.WorkspaceService/GetWorkspace' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Responses

{
  "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"
  }
}