Used to return the setup status of the workspace

GET 
/api/v2/workspaces/:workspace/uisetup

Used to return the setup status of the workspace

Request

Path Parameters

workspace stringrequired

Workspace to use

Responses

200

Returns the present UI setup state for the specified workspace

application/json

Schema

Schema

applications

required

total int32required

clouds

required

aws

required

enabled booleanrequired

stages string[]

azure

required

enabled booleanrequired

stages string[]

gcp

required

enabled booleanrequired

stages string[]

clusters

required

stages

object

required

property name* integer

summary

undefined[]

required

Array [

environments int32required

name stringrequired

namespaces int32required

provider stringrequired

stage stringrequired

]

total int32required

environments

required

stages

object

required

property name* integer

total int32required
memberCount int32required

namespaces

required

stages

object

required

property name* integer

total int32required
workspaceKey stringrequired

Example (from schema)

{
  "applications": {
    "total": 0
  },
  "clouds": {
    "aws": {
      "enabled": true,
      "stages": [
        "string"
      ]
    },
    "azure": {
      "enabled": true,
      "stages": [
        "string"
      ]
    },
    "gcp": {
      "enabled": true,
      "stages": [
        "string"
      ]
    }
  },
  "clusters": {
    "stages": {},
    "summary": [
      {
        "environments": 0,
        "name": "string",
        "namespaces": 0,
        "provider": "string",
        "stage": "string"
      }
    ],
    "total": 0
  },
  "environments": {
    "stages": {},
    "total": 0
  },
  "memberCount": 0,
  "namespaces": {
    "stages": {},
    "total": 0
  },
  "workspaceKey": "string"
}

401

If not authenticated

403

If authenticated but not authorized

404

Workspace does not exist

500

A generic API error containing the cause of the error

application/json

Schema

Schema

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

{
  "code": 0,
  "detail": "string",
  "message": "string",
  "uri": "string",
  "verb": "string"
}

Loading...