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

accessPolicyCount int32required
accessRoleCount int32required
aksClusterPlanCount int32required
appCount int32required

appSummary

undefined[]

required

Array [

cloud stringrequired

name stringrequired

stages string[]required

]

cloudAccounts

required

managedAccountCount int32required

organizationCount int32required

sharedAccountCount int32required

summaryList

undefined[]

required

Array [

cloud stringrequired

name stringrequired

stage stringrequired

type stringrequired

]

clusterCount int32required
clusterPlanCount int32required

clusterSummaryList

undefined[]

required

Array [

environments int32required

name stringrequired

namespaces int32required

provider stringrequired

stage stringrequired

]

costs

required

audit booleanrequired

estimates booleanrequired
eksClusterPlanCount int32required
emptyWorkspaceCount int32required
fromCache booleanrequired
gkeClusterPlanCount int32required
idpConfigured booleanrequired

namespaceSummaryList

undefined[]

required

Array [

name stringrequired

provider stringrequired

stage stringrequired

]

networking

required

assignableNetworksCount int32required

dnsZones

required

globalZoneCount int32required

zoneCount int32required

peeringRuleCount int32required
packages int32required
stageCount int32required
userCount int32required
wayfinderAdminCount int32required
workspaceAdminCount int32required
workspaceCount int32required
workspaceGroupCount int32required
workspaceMemberCount int32required

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

code int32required
detail stringrequired
message stringrequired
uri stringrequired
verb stringrequired

Example (from schema)

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

Loading...