/
KU
kubesphere
/
KS API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 49m ago · Updated 1mo ago
Details
Filter operations
Access Management
15
get
List all members of cluster
post
Add members to cluster
put
Update member from the cluster
delete
Delete member from cluster
get
List all members in the specified namespace
post
Add members to the namespace in bulk.
delete
Delete a member from the namespace
put
Update member from the namespace
post
Create subject access review
get
List all role templates of the specified user
get
List all members in the specified workspace
post
Add members to the specified workspace
get
Get workspace member
put
Update member from the workspace
delete
Delete a member from the workspace
Advanced Operations
4
post
Job rerun
post
Verify the git credential
get
Retrieve the blob from the registry
post
Verify registry credential
Authentication
9
get
OpenID provider configuration information
post
Token review
get
Authorization endpoint
post
Authorization endpoint
get
OAuth2 callback
get
JSON Web Key Set
get
Logout
post
Token endpoint
get
User info endpoint
Cluster Resources
5
get
Get abnormal workloads
get
Get whole cluster's resource usage
get
Cluster summary
get
Cluster level resources
get
Get cluster scope resource
Component Status
6
get
Get the health status of system components
get
List the system components
get
Describe the specified system component
get
Get the health status of system components
get
List the system components
get
Describe the specified system component
Identity Management
7
get
List users
post
Create user
get
Get user
put
Update user
delete
Delete user
get
List login records
put
Reset password
Multi-cluster
7
post
Cluster validation
put
Update kubeconfig
post
Binding clusters.
get
List labels.
post
Create cluster labels.
delete
Delete cluster labels.
put
Update a label.
Namespaced Resources
11
get
Get abnormal workloads
get
Get the specified daemonSet revision
get
Get the specified deployment revision
get
get specified namespace's resource quota and usage
get
Get the specified statefulSet revision
get
Get image config
get
Namespace summary
post
Verify registry credential
get
List image tags
get
List resources at namespace scope
get
Get namespace scope resource
NonResource APIs
2
get
KubeSphere version info
get
KubeSphere version info
Platform Configurations
4
get
Component configurations
get
OAuth configurations
get
Retrieve theme configurations
post
Update theme configurations
User Related Resources
39
post
Patch workspace template's visibility in different clusters
get
Get users' kubeconfig
get
List clusters available to users
get
List the namespaces for the current user
get
List all workspaces that belongs to the current user
get
Get workspace.
get
List clusters authorized to the specified workspace.
get
List the namespaces of the specified workspace for the current user
get
Retrieve namespace details.
get
List all workspaces that belongs to the current user
get
Describe workspace.
get
List clusters available to users
get
Get platform metrics
get
List the namespaces for the current user
get
List workspaces
post
Create workspace
get
Get workspace
put
Update workspace
delete
Delete workspace
patch
Update workspace
get
List clusters authorized to the specified workspace
get
Get workspace metrics
get
List the namespaces in workspace
post
Create namespace in workspace
get
Get namespace
put
Update namespace
delete
Delete namespace from workspace
patch
Patch namespace
post
Create workspace resource quota
get
Get workspace resource quota
put
Update workspace resource quota
delete
Delete workspace resource quota.
get
List namespaces in workspace of the member
get
List all workspace templates
post
Create workspace template
get
Get workspace template
put
Update workspace template
delete
Delete workspace template
patch
Patch workspace template
Web Terminal
5
get
Create pod terminal session
get
Download file from pod
post
Upload files to pod
get
Create node terminal session
get
Create kubectl pod terminal session for current user
get
/kapis/application.kubesphere.io/v2/applications
post
/kapis/application.kubesphere.io/v2/applications
get
/kapis/application.kubesphere.io/v2/applications/{application}
post
/kapis/application.kubesphere.io/v2/applications/{application}
delete
/kapis/application.kubesphere.io/v2/applications/{application}
get
/kapis/application.kubesphere.io/v2/apps
post
/kapis/application.kubesphere.io/v2/apps
get
/kapis/application.kubesphere.io/v2/apps/{app}
post
/kapis/application.kubesphere.io/v2/apps/{app}
delete
/kapis/application.kubesphere.io/v2/apps/{app}
patch
/kapis/application.kubesphere.io/v2/apps/{app}
post
/kapis/application.kubesphere.io/v2/apps/{app}/action
get
/kapis/application.kubesphere.io/v2/apps/{app}/cr
get
/kapis/application.kubesphere.io/v2/apps/{app}/examplecr/{name}
get
/kapis/application.kubesphere.io/v2/apps/{app}/versions
post
/kapis/application.kubesphere.io/v2/apps/{app}/versions
get
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}
post
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}
delete
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}
post
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}/action
get
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}/files
get
/kapis/application.kubesphere.io/v2/apps/{app}/versions/{version}/package
post
/kapis/application.kubesphere.io/v2/attachments
get
/kapis/application.kubesphere.io/v2/attachments/{attachment}
delete
/kapis/application.kubesphere.io/v2/attachments/{attachment}
get
/kapis/application.kubesphere.io/v2/categories
post
/kapis/application.kubesphere.io/v2/categories
get
/kapis/application.kubesphere.io/v2/categories/{category}
post
/kapis/application.kubesphere.io/v2/categories/{category}
delete
/kapis/application.kubesphere.io/v2/categories/{category}
post
/kapis/application.kubesphere.io/v2/cr
get
/kapis/application.kubesphere.io/v2/cr/{crname}
delete
/kapis/application.kubesphere.io/v2/cr/{crname}
get
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/applications
post
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/applications
get
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/applications/{application}
post
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/applications/{application}
delete
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/applications/{application}
get
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/apps/{app}/cr
post
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/cr
get
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/cr/{crname}
delete
/kapis/application.kubesphere.io/v2/namespaces/{namespace}/cr/{crname}
get
/kapis/application.kubesphere.io/v2/repos
post
/kapis/application.kubesphere.io/v2/repos
get
/kapis/application.kubesphere.io/v2/repos/{repo}
delete
/kapis/application.kubesphere.io/v2/repos/{repo}
patch
/kapis/application.kubesphere.io/v2/repos/{repo}
get
/kapis/application.kubesphere.io/v2/repos/{repo}/events
get
/kapis/application.kubesphere.io/v2/reviews
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/applications
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/applications
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}
delete
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}
patch
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/cr
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/examplecr/{name}
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}
delete
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}/action
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}/files
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/apps/{app}/versions/{version}/package
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/attachments
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/attachments/{attachment}
delete
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/attachments/{attachment}
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/cr
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/cr/{crname}
delete
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/cr/{crname}
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos
post
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos/{repo}
delete
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos/{repo}
patch
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos/{repo}
get
/kapis/application.kubesphere.io/v2/workspaces/{workspace}/repos/{repo}/events
get
List ingressClassScope available for the namespace
get
List all files
post
Upload image
get
Get image file
Authentication
OpenID provider configuration information
The OpenID Provider's configuration information can be retrieved.
get
/.well-known/openid-configuration
Response
ok
OauthProviderMetadata
required
authorization_endpoint
string
required
claims_supported
string[]
required
code_challenge_methods_supported
string[]
required
grant_types_supported
string[]
required
id_token_signing_alg_values_supported
string[]
required
issuer
string
required
jwks_uri
string
required
response_types_supported
string[]
required
scopes_supported
string[]
required
subject_types_supported
string[]
required
token_endpoint
string
required
token_endpoint_auth_methods_supported
string[]
required
userinfo_endpoint
string
required
Changes