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

totalint32required

clouds

required

aws

required

enabledbooleanrequired

stagesstring[]

azure

required

enabledbooleanrequired

stagesstring[]

gcp

required

enabledbooleanrequired

stagesstring[]

stages

object

required

property name*integer

totalint32required

clusters

required

stages

object

required

property name*integer

summary

undefined[]

required

Array [

environmentsint32required

namestringrequired

namespacesint32required

providerstringrequired

stagestringrequired

]

totalint32required

environments

required

stages

object

required

property name*integer

totalint32required
memberCountint32required

namespaces

required

stages

object

required

property name*integer

totalint32required
workspaceKeystringrequired

Example (from schema)

{
  "applications": {
    "total": 0
  },
  "clouds": {
    "aws": {
      "enabled": true,
      "stages": [
        "string"
      ]
    },
    "azure": {
      "enabled": true,
      "stages": [
        "string"
      ]
    },
    "gcp": {
      "enabled": true,
      "stages": [
        "string"
      ]
    },
    "stages": {},
    "total": 0
  },
  "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

codeint32required
detailstringrequired
messagestringrequired
uristringrequired
verbstringrequired

Example (from schema)

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