Retrieve the UI setup

GET 
/api/v2/uisetup

Retrieve the UI setup

Request

Responses

200

Contains the present UI setup state

application/json

Schema

Schema

accessPolicyCountint32required
accessRoleCountint32required
aksClusterPlanCountint32required
appCountint32required

appSummary

undefined[]

required

Array [

cloudstringrequired

namestringrequired

stagesstring[]required

]

cloudAccounts

required

managedAccountCountint32required

organizationCountint32required

sharedAccountCountint32required

summaryList

undefined[]

required

Array [

cloudstringrequired

namestringrequired

stagestringrequired

typestringrequired

]

clusterCountint32required
clusterPlanCountint32required

clusterSummaryList

undefined[]

required

Array [

environmentsint32required

namestringrequired

namespacesint32required

providerstringrequired

stagestringrequired

]

costs

required

auditbooleanrequired

estimatesbooleanrequired
eksClusterPlanCountint32required
emptyWorkspaceCountint32required
fromCachebooleanrequired
gkeClusterPlanCountint32required
idpConfiguredbooleanrequired

namespaceSummaryList

undefined[]

required

Array [

namestringrequired

providerstringrequired

stagestringrequired

]

networking

required

assignableNetworksCountint32required

dnsZones

required

globalZoneCountint32required

zoneCountint32required

peeringRuleCountint32required
packagesint32required
stageCountint32required
userCountint32required
wayfinderAdminCountint32required
workspaceAdminCountint32required
workspaceCountint32required
workspaceGroupCountint32required
workspaceMemberCountint32required

Example (from schema)

{
  "accessPolicyCount": 0,
  "accessRoleCount": 0,
  "aksClusterPlanCount": 0,
  "appCount": 0,
  "appSummary": [
    {
      "cloud": "string",
      "name": "string",
      "stages": [
        "string"
      ]
    }
  ],
  "cloudAccounts": {
    "managedAccountCount": 0,
    "organizationCount": 0,
    "sharedAccountCount": 0,
    "summaryList": [
      {
        "cloud": "string",
        "name": "string",
        "stage": "string",
        "type": "string"
      }
    ]
  },
  "clusterCount": 0,
  "clusterPlanCount": 0,
  "clusterSummaryList": [
    {
      "environments": 0,
      "name": "string",
      "namespaces": 0,
      "provider": "string",
      "stage": "string"
    }
  ],
  "costs": {
    "audit": true,
    "estimates": true
  },
  "eksClusterPlanCount": 0,
  "emptyWorkspaceCount": 0,
  "fromCache": true,
  "gkeClusterPlanCount": 0,
  "idpConfigured": true,
  "namespaceSummaryList": [
    {
      "name": "string",
      "provider": "string",
      "stage": "string"
    }
  ],
  "networking": {
    "assignableNetworksCount": 0,
    "dnsZones": {
      "globalZoneCount": 0,
      "zoneCount": 0
    },
    "peeringRuleCount": 0
  },
  "packages": 0,
  "stageCount": 0,
  "userCount": 0,
  "wayfinderAdminCount": 0,
  "workspaceAdminCount": 0,
  "workspaceCount": 0,
  "workspaceGroupCount": 0,
  "workspaceMemberCount": 0
}

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