Cloud Manager Devops Rest API
Project REST Endpoints
This section describes endpoints for Project management.
ProjectRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/project//env | GET | Environment getEnv | ||||||
| /api/project//env/ | DELETE | deleteVariable | ||||||
| /api/project/ | PUT | updateProject | Project | |||||
| /api/project/ | DELETE | deleteProject | ||||||
| /api/project | GET | PageProject listsProjects | ProjectFilter PageOptions | |||||
| /api/project | POST | createProject | Project | |||||
| /api/project//env/ | GET | Variable getVariable | ||||||
| /api/project//env | POST | addVariable | Variable | |||||
| /api/project/ | POST | createSpace | Space | |||||
| /api/project/ | GET | Project getProject |
Deployment Web Endpoints
DeploymentController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /deploy/ /admin/deploy/ | DELETE | DELETE | ||||||
| /deploy//start /admin/deploy//start | POST | start | ||||||
| /deploy//stop /admin/deploy//stop | POST | stop | ||||||
| /deploy//sync /admin/deploy//sync | POST | sync | ||||||
| /deploy//restart /admin/deploy//restart | POST | restart | ||||||
| /deploy//binding /admin/deploy//binding | GET | listBindings | ||||||
| /deploy//build /admin/deploy//build | POST | build | BuildOptions | |||||
| /deploy/ /admin/deploy/ | GET | show | ||||||
| /deploy/ /admin/deploy/ | PUT | editPUT | Deployment | |||||
| /deploy//edit /admin/deploy//edit | GET | editGET | ||||||
| /deploy//pod /deploy//instance /admin/deploy//pod /admin/deploy//instance | GET | showPods | ||||||
| /deploy//binding/ /admin/deploy//binding/ | GET | showBinding | ||||||
| /deploy//connector /admin/deploy//connector | GET | listConnectors | ||||||
| /deploy//route/ /admin/deploy//route/ | GET | showRoute | ||||||
| /deploy//route /admin/deploy//route | GET | listRoutes | ||||||
| /deploy//connector/ /admin/deploy//connector/ | GET | showConnector |
Space REST Endpoints
This section describes endpoints for Space management.
Table below provides a quick summary:
SpaceRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/space//resource/ /api/admin/space//resource/ | GET | Resource getResource | ||||||
| /api/space//auth/ /api/admin/space//auth/ | GET | Authority getAuthority | ||||||
| /api/space/ /api/admin/space/ | GET | Space getSpace | ||||||
| /api/space//deploy//logs /api/space//deployment//logs /api/space//pod//logs /api/space//instance//logs /api/admin/space//deploy//logs /api/admin/space//deployment//logs /api/admin/space//pod//logs /api/admin/space//instance//logs | GET | getLog | LogOptions | |||||
| /api/space//task/ /api/admin/space//task/ | GET | Task getTask | ||||||
| /api/space//certificate /api/space//certificate/** /api/space//config /api/space//config/** /api/admin/space//certificate /api/admin/space//certificate/** /api/admin/space//config /api/admin/space//config/** | GET]produces=[application/x-yaml text/yaml text/plain application/json | getCertificate | ||||||
| /api/space//env /api/admin/space//env | GET | []Variable getEnv | ||||||
| /api/space//volumeclaim /api/admin/space//volumeclaim | POST | createVolumeClaim | VolumeClaim | |||||
| /api/space//volumeclaim/ /api/admin/space//volumeclaim/ | DELETE | deleteVolumeClaim | ||||||
| /api/space//rolebinding /api/admin/space//rolebinding | POST | createRoleBinding | RoleBinding | |||||
| /api/space//rolebinding/ /api/admin/space//rolebinding/ | DELETE | deleteRoleBinding | ||||||
| /api/space//deploy /api/admin/space//deploy | DELETE | deleteManyDeployment | [] | |||||
| /api/space//env /api/admin/space//env | DELETE | deleteManyVariable | [] | |||||
| /api/space//connector /api/admin/space//connector | GET | []Connector listConnectorsFor | ||||||
| /api/space//pipelinerun/ /api/admin/space//pipelinerun/ | DELETE | deletePipelineRun | ||||||
| /api/space//volc /api/admin/space//volc | DELETE | deleteManyVolumeClaim | [] | |||||
| /api/space//connector /api/admin/space//connector | DELETE | deleteManyConnector | [] | |||||
| /api/space//pipeline /api/admin/space//pipeline | DELETE | deleteManyPipeline | [] | |||||
| /api/space//run /api/admin/space//run | DELETE | deleteManyPipelineRun | [] | |||||
| /api/space//auth /api/admin/space//auth | DELETE | deleteManyAuthority | [] | |||||
| /api/space//pipelinerun/ /api/admin/space//pipelinerun/ | PUT | updatePipelineRun | PipelineRun | |||||
| /api/space//auth /api/admin/space//auth | GET | []Authority listAuthoritiesFor | ||||||
| /api/space//configmap /api/admin/space//configmap | DELETE | deleteManyConfigmap | [] | |||||
| /api/space//cronjob /api/admin/space//cronjob | DELETE | deleteManyCronJob | [] | |||||
| /api/space//service /api/admin/space//service | DELETE | deleteManyService | [] | |||||
| /api/space//rolebinding /api/admin/space//rolebinding | DELETE | deleteManyRoleBinding | [] | |||||
| /api/space//ingress /api/admin/space//ingress | DELETE | deleteManyIngress | [] | |||||
| /api/space//resource /api/admin/space//resource | DELETE | deleteManyResource | [] | |||||
| /api/space//secret /api/admin/space//secret | POST | createSecret | Secret | |||||
| /api/space//deployment /api/admin/space//deployment | POST | createDeployment | Deployment | |||||
| /api/space//resource/ /api/admin/space//resource/ | DELETE | deleteResource | ||||||
| /api/space//volumeclaim /api/admin/space//volumeclaim | GET | []VolumeClaim listVolumeClaims | ||||||
| /api/space//ingress/ /api/admin/space//ingress/ | DELETE | deleteIngress | ||||||
| /api/space//configmap/ /api/admin/space//configmap/ | DELETE | deleteConfigMap | ||||||
| /api/space//configmap /api/admin/space//configmap | POST | createConfigMap | ConfigMap | |||||
| /api/space//cronjob /api/admin/space//cronjob | POST | createCronJob | CronJob | |||||
| /api/space//job /api/admin/space//job | GET | []Job listJobs | ||||||
| /api/space//job /api/admin/space//job | POST | createJob | Job | |||||
| /api/space//role /api/admin/space//role | POST | createRole | Role | |||||
| /api/space//rolebinding/ /api/admin/space//rolebinding/ | GET | RoleBinding getRoleBinding | ||||||
| /api/space//role/ /api/admin/space//role/ | DELETE | deleteRole | ||||||
| /api/space//cronjob /api/admin/space//cronjob | GET | []CronJob listCronJobs | ||||||
| /api/space/ /api/admin/space/ | PUT | updateSpace | Space | |||||
| /api/space//service//route/ /api/admin/space//service//route/ | GET | Route getRoute | ||||||
| /api/space//secret/ /api/admin/space//secret/ | PUT | updateSecret | Secret | |||||
| /api/space//task/ /api/admin/space//task/ | DELETE | deleteTask | ||||||
| /api/space//configmap/ /api/admin/space//configmap/ | PUT | updateConfigMap | ConfigMap | |||||
| /api/space//taskrun/ /api/admin/space//taskrun/ | DELETE | deleteTaskRun | ||||||
| /api/space//taskrun/ /api/admin/space//taskrun/ | GET | TaskRun getTaskRun | ||||||
| /api/space//pipeline/ /api/admin/space//pipeline/ | DELETE | deletePipeline | ||||||
| /api/space//env/ /api/admin/space//env/ | DELETE | deleteVariable | ||||||
| /api/space//pipelinerun/ /api/admin/space//pipelinerun/ | GET | PipelineRun getPipelineRun | ||||||
| /api/space//service//route/ /api/admin/space//service//route/ | PUT | Route putRoute | Route | |||||
| /api/space//service//route/ /api/admin/space//service//route/ | DELETE | deleteRoute | ||||||
| /api/space//service//route /api/admin/space//service//route | GET | []Route listRoutesFor | ||||||
| /api/space//connector/ /api/admin/space//connector/ | DELETE | deleteConnector | ||||||
| /api/space//taskrun /api/admin/space//taskrun | DELETE | deleteTaskRuns | [] | |||||
| /api/space//pipeline/ /api/admin/space//pipeline/ | PUT | updatePipeline | Pipeline | |||||
| /api/space/ /api/admin/space/ | DELETE | deleteSpace | ||||||
| /api/space//taskrun/ /api/admin/space//taskrun/ | PUT | updateTaskRun | TaskRun | |||||
| /api/space//deploy /api/space//deployment /api/space//pod /api/space//instance /api/admin/space//deploy /api/admin/space//deployment /api/admin/space//pod /api/admin/space//instance | DELETE | deleteManyPod | [] | |||||
| /api/space//pod/ /api/space//instance/ /api/admin/space//pod/ /api/admin/space//instance/ | DELETE | deletePod | ||||||
| /api/space//deployment /api/admin/space//deployment | GET | PageDeployment listDeployment | ||||||
| /api/space//secret /api/admin/space//secret | DELETE | deleteManySecret | [] | |||||
| /api/space//auth/ /api/admin/space//auth/ | DELETE | deleteAuthority | ||||||
| /api/space//job /api/admin/space//job | DELETE | deleteManyJob | [] | |||||
| /api/space//configmap/ /api/admin/space//configmap/ | GET | ConfigMap getConfigMap | ||||||
| /api/space//task/ /api/admin/space//task/ | PUT | updateTask | Task | |||||
| /api/space//task /api/admin/space//task | DELETE | deleteManyTask | [] | |||||
| /api/space//resource/ /api/admin/space//resource/ | PUT | updateResource | Resource | |||||
| /api/space//certificate /api/admin/space//certificate | DELETE | delCertificate | ||||||
| /api/space//role /api/admin/space//role | DELETE | deleteManyRole | [] | |||||
| /api/space//certificate /api/admin/space//certificate | POST | issueCertificate | ||||||
| /api/space//service//route /api/admin/space//service//route | DELETE | deleteManyRoutes | [] | |||||
| /api/space//service//route/ /api/admin/space//service//route/ | POST | Route setPrimary | ||||||
| /api/space//env/ /api/admin/space//env/ | GET | Variable getVariable | ||||||
| /api/space//connector/ /api/admin/space//connector/ | GET | Connector getConnector | ||||||
| /api/space//auth/ /api/admin/space//auth/ | PUT | updateAuthority | Authority | |||||
| /api/space//auth//resend /api/admin/space//auth//resend | POST | resendInvite | ||||||
| /api/space//secret /api/admin/space//secret | GET | []Secret listSecrets | ||||||
| /api/space//env/ /api/admin/space//env/ | PUT | updateVariable | Variable | |||||
| /api/space//secret/ /api/admin/space//secret/ | GET | Secret getSecret | ||||||
| /api/space//service//route /api/admin/space//service//route | POST | addRoute | Route | |||||
| /api/space//connector/ /api/admin/space//connector/ | PUT | updateConnector | Connector | |||||
| /api/space//secret/ /api/admin/space//secret/ | DELETE | deleteSecret | ||||||
| /api/space//connector//refresh /api/admin/space//connector//refresh | POST | refreshConnector | ||||||
| /api/space//role/ /api/admin/space//role/ | GET | Role getRole | ||||||
| /api/space//pipeline/ /api/admin/space//pipeline/ | GET | Pipeline getPipeline | ||||||
| /api/space//connector /api/admin/space//connector | POST | addConnector | Connector | |||||
| /api/space//configmap /api/admin/space//configmap | GET | []ConfigMap listConfigMaps | ||||||
| /api/space//auth /api/admin/space//auth | POST | addAuthority | Authority | |||||
| /api/space//env /api/admin/space//env | POST | addVariable | Variable | |||||
| /api/space /api/admin/space | POST | createSpace | Space | |||||
| /api/space//job/ /api/admin/space//job/ | PUT | updateJob | Job | |||||
| /api/space//job/ /api/admin/space//job/ | GET | Job getJob | ||||||
| /api/space//pipeline /api/admin/space//pipeline | GET | []Pipeline listPipelines | PipelineFilter | |||||
| /api/space//taskRun /api/admin/space//taskRun | POST | createTaskRun | TaskRun | |||||
| /api/space//resource /api/admin/space//resource | POST | createResource | Resource | |||||
| /api/space//resource /api/admin/space//resource | GET | []Resource listResources | ResourceFilter | |||||
| /api/space//task /api/admin/space//task | GET | []Task listTasks | TaskFilter | |||||
| /api/space//pipelinerun /api/admin/space//pipelinerun | GET | []PipelineRun listPipelineRuns | PipelineRunFilter | |||||
| /api/space//job/ /api/admin/space//job/ | DELETE | deleteJob | ||||||
| /api/space//cronjob/ /api/admin/space//cronjob/ | PUT | updateCronJob | CronJob | |||||
| /api/space//cronjob/ /api/admin/space//cronjob/ | DELETE | deleteCronJob | ||||||
| /api/space//task /api/admin/space//task | POST | createTask | Task | |||||
| /api/space//pipeline /api/admin/space//pipeline | POST | createPipeline | Pipeline | |||||
| /api/space//cronjob/ /api/admin/space//cronjob/ | GET | CronJob getCronJob | ||||||
| /api/space//taskrun /api/admin/space//taskrun | GET | []TaskRun listTaskRuns | TaskRunFilter | |||||
| /api/space//service//uninstall /api/admin/space//service//uninstall | DELETE | uninstallService | ||||||
| /api/space//role /api/admin/space//role | GET | []Role listRoles | ||||||
| /api/space//rolebinding /api/admin/space//rolebinding | GET | []RoleBinding listRoleBindings | ||||||
| /api/space//service/ /api/admin/space//service/ | DELETE | deleteService | ||||||
| /api/space//pipelinerun /api/admin/space//pipelinerun | POST | createPipelineRun | PipelineRun |
Deployment Rest Endpoints
This section describes endpoints for Deployment management.
Table below provides a quick summary:
DeploymentRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//start /api/admin/deploy//start /api/deployment//start /api/admin/deployment//start | POST | start | ||||||
| /api/deploy//stop /api/admin/deploy//stop /api/deployment//stop /api/admin/deployment//stop | POST | stop | ||||||
| /api/deploy//exec /api/admin/deploy//exec /api/deployment//exec /api/admin/deployment//exec | GET | exec | ||||||
| /api/deploy//sync /api/admin/deploy//sync /api/deployment//sync /api/admin/deployment//sync | POST | sync | ||||||
| /api/deploy//scale /api/admin/deploy//scale /api/deployment//scale /api/admin/deployment//scale | POST | scale | Integer | |||||
| /api/deploy//restart /api/admin/deploy//restart /api/deployment//restart /api/admin/deployment//restart | POST | restart | ||||||
| /api/deploy//logs /api/admin/deploy//logs /api/deployment//logs /api/admin/deployment//logs | GET | getLog | LogOptions | |||||
| /api/deploy//env /api/admin/deploy//env /api/deployment//env /api/admin/deployment//env | GET | []Variable getEnv | ||||||
| /api/deploy//build /api/admin/deploy//build /api/deployment//build /api/admin/deployment//build | POST | build | BuildOptions | |||||
| /api/deploy /api/admin/deploy /api/deployment /api/admin/deployment | DELETE | deleteManyDeployment | [] | |||||
| /api/deploy//logfollow /api/admin/deploy//logfollow /api/deployment//logfollow /api/admin/deployment//logfollow | GET | logFollow | LogOptions | |||||
| /api/deploy//rscale /api/admin/deploy//rscale /api/deployment//rscale /api/admin/deployment//rscale | POST | rscale | Resources |
Route Rest Endpoints
This section describes endpoints for Route management.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//route/ /api/admin/deploy//route/ /api/deployment//route/ /api/admin/deployment//route/ | GET | Route getRoute | ||||||
| /api/deploy//route /api/admin/deploy//route /api/deployment//route /api/admin/deployment//route | GET | []Route listRoutesFor | ||||||
| /api/deploy//binding/refresh /api/admin/deploy//binding/refresh /api/deployment//binding/refresh /api/admin/deployment//binding/refresh | POST | refreshBindings | [] | |||||
| /api/deploy//configmap/ /api/admin/deploy//configmap/ /api/deployment//configmap/ /api/admin/deployment//configmap/ | DELETE | deleteConfigmap | ||||||
| /api/deploy//binding /api/admin/deploy//binding /api/deployment//binding /api/admin/deployment//binding | POST]params=[n | addBindings | Binding[] | |||||
| /api/deploy//connector/ /api/admin/deploy//connector/ /api/deployment//connector/ /api/admin/deployment//connector/ | DELETE | deleteConnector | ||||||
| /api/deploy//mount/ /api/admin/deploy//mount/ /api/deployment//mount/ /api/admin/deployment//mount/ | POST | allocateMount | ||||||
| /api/deploy//route/ /api/admin/deploy//route/ /api/deployment//route/ /api/admin/deployment//route/ | POST | Route setPrimary | ||||||
| /api/deploy//binding/ /api/admin/deploy//binding/ /api/deployment//binding/ /api/admin/deployment//binding/ | GET | Binding getBinding | ||||||
| /api/deploy//env/ /api/admin/deploy//env/ /api/deployment//env/ /api/admin/deployment//env/ | GET | Variable getVariable | ||||||
| /api/deploy//connector/ /api/admin/deploy//connector/ /api/deployment//connector/ /api/admin/deployment//connector/ | GET | Connector getConnector | ||||||
| /api/deploy/ /api/admin/deploy/ /api/deployment/ /api/admin/deployment/ | GET | Deployment getDeployment | ||||||
| /api/deploy/ /api/admin/deploy/ /api/deployment/ /api/admin/deployment/ | PUT | updateDeployment | Deployment | |||||
| /api/deploy//route /api/admin/deploy//route /api/deployment//route /api/admin/deployment//route | POST | addRoute | Route | |||||
| /api/deploy//binding//refresh /api/admin/deploy//binding//refresh /api/deployment//binding//refresh /api/admin/deployment//binding//refresh | POST | refreshBinding |
Bindings Rest Endpoints
This section describes endpoints for Binding management.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//binding/ /api/admin/deploy//binding/ /api/deployment//binding/ /api/admin/deployment//binding/ | PUT | updateBinding | Binding | |||||
| /api/deploy//binding /api/admin/deploy//binding /api/deployment//binding /api/admin/deployment//binding | POST | addBinding | Binding | |||||
| /api/deploy//binding/ /api/admin/deploy//binding/ /api/deployment//binding/ /api/admin/deployment//binding/ | DELETE | deleteBinding | ||||||
| /api/deploy//route/ /api/admin/deploy//route/ /api/deployment//route/ /api/admin/deployment//route/ | PUT | Route putRoute | Route | |||||
| /api/deploy//mount/ /api/admin/deploy//mount/ /api/deployment//mount/ /api/admin/deployment//mount/ | DELETE | deleteMount | ||||||
| /api/deploy//logunfollow /api/admin/deploy//logunfollow /api/deployment//logunfollow /api/admin/deployment//logunfollow | GET | logUnfollow | LogOptions | |||||
| /api/deploy//binding /api/admin/deploy//binding /api/deployment//binding /api/admin/deployment//binding | GET | []Binding listBindingsFor | ||||||
| /api/deploy//binding /api/admin/deploy//binding /api/deployment//binding /api/admin/deployment//binding | DELETE | deleteManyBinding | [] |
Mount Rest Endpoints
This section describes endpoints for configuration of Deployment Mounts (Persistent Volumes and Secrets).
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//mount/ /api/admin/deploy//mount/ /api/deployment//mount/ /api/admin/deployment//mount/ | GET | Mount getMount | ||||||
| /api/deploy//mount /api/admin/deploy//mount /api/deployment//mount /api/admin/deployment//mount | GET | []Mount listMountsFor |
Deployment Environment Rest Endpoints
This section describes endpoints for configuration of Deployment Environment.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//route/ /api/admin/deploy//route/ /api/deployment//route/ /api/admin/deployment//route/ | DELETE | deleteRoute | ||||||
| /api/deploy//env/ /api/admin/deploy//env/ /api/deployment//env/ /api/admin/deployment//env/ | PUT | updatedVariable | Variable | |||||
| /api/deploy//env/ /api/admin/deploy//env/ /api/deployment//env/ /api/admin/deployment//env/ | DELETE | deleteVariable | ||||||
| /api/deploy//env /api/admin/deploy//env /api/deployment//env /api/admin/deployment//env | DELETE | deleteManyVariable | [] |
Connector Rest Endpoints
This section describes endpoints for Connector management.
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//connector /api/admin/deploy//connector /api/deployment//connector /api/admin/deployment//connector | GET | []Connector listConnectorsFor | ||||||
| /api/deploy//connector/ /api/admin/deploy//connector/ /api/deployment//connector/ /api/admin/deployment//connector/ | PUT | updateConnector | Connector | |||||
| /api/deploy/ /api/admin/deploy/ /api/deployment/ /api/admin/deployment/ | DELETE | deleteDeployment | ||||||
| /api/deploy//connector//refresh /api/admin/deploy//connector//refresh /api/deployment//connector//refresh /api/admin/deployment//connector//refresh | POST | refreshConnector | ||||||
| /api/deploy//connector /api/admin/deploy//connector /api/deployment//connector /api/admin/deployment//connector | POST | addConnector | Connector | |||||
| /api/deploy//repository/ /api/admin/deploy//repository/ /api/deployment//repository/ /api/admin/deployment//repository/ | GET | Repository getRepository | ||||||
| /api/deploy//env /api/admin/deploy//env /api/deployment//env /api/admin/deployment//env | POST | addVariable | Variable | |||||
| /api/deploy//configmap/ /api/admin/deploy//configmap/ /api/deployment//configmap/ /api/admin/deployment//configmap/ | POST | addConfigmap |
Domain REST Endpoints
This section describes endpoints for Route management.
DomainRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/domain/ | GET | Domain getDomain | ||||||
| /api/domain/ | DELETE | deleteDomain | ||||||
| /api/domain | POST | createDomain | Domain | |||||
| /api/domain/ | PUT | updateDomain | Domain | |||||
| /api/domain | GET | PageDomain listsDomains | DomainFilter PageOptions | |||||
| /api/domain | DELETE | deleteMany | [] |
Registry REST Endpoints
This section describes endpoints for Registry management.
RegistryController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|
TODO
File System Endpoints
This section describes endpoints for File System access.
Table below provides a quick summary:
FileManagerRestController::
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/fs//file | GET | file | ||||||
| /api/fs//ls | GET | [] File listFiles | ||||||
| /api/fs//mkdir | POST | mkdir | ||||||
| /api/fs//upload | POST | upload | MultipartFile Request | |||||
| /api/fs//repo-upload | POST | repoUpload | ||||||
| /api/fs//file | DELETE | rm | ||||||
| /api/fs//file/** | GET | file |
MySQL Endpoints
This section describes endpoints for MySQL database management.
Table below provides a quick summary:
MySqlRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/mysql//database/ /api/admin/mysql//database/ | GET | execSql | ||||||
| /api/mysql//pod//database/ /api/admin/mysql//pod//database/ | GET | execSql | ||||||
| /api/mysql//pod//user/ /api/admin/mysql//pod//user/ | DELETE | dropUser | ||||||
| /api/mysql//user/ /api/admin/mysql//user/ | DELETE | dropUser | ||||||
| /api/mysql//pod//database//table /api/admin/mysql//pod//database//table | GET | listTables | ||||||
| /api/mysql//database//table /api/admin/mysql//database//table | GET | listTables | ||||||
| /api/mysql//database//tables /api/admin/mysql//database//tables | GET | [] getTables | ||||||
| /api/mysql//pod//database//tables /api/admin/mysql//pod//database//tables | GET | [] getTables | ||||||
| /api/mysql//pod//database/ /api/admin/mysql//pod//database/ | POST | addDatabase | ||||||
| /api/mysql//database/ /api/admin/mysql//database/ | POST | addDatabase | ||||||
| /api/mysql//pod//user /api/admin/mysql//pod//user | GET | []java.util.Map listUsers | ||||||
| /api/mysql//user /api/admin/mysql//user | GET | []java.util.Map listUsers | ||||||
| /api/mysql//pod//user/ /api/admin/mysql//pod//user/ | POST | addUser | UserForm | |||||
| /api/mysql//user/ /api/admin/mysql//user/ | POST | addUser | UserForm | |||||
| /api/mysql//pod//database /api/admin/mysql//pod//database | GET | [] listDatabases | ||||||
| /api/mysql//database /api/admin/mysql//database | GET | [] listDatabases | ||||||
| /api/mysql//pod//database/ /api/admin/mysql//pod//database/ | DELETE | dropDatabase | ||||||
| /api/mysql//database/ /api/admin/mysql//database/ | DELETE | dropDatabase |
Solutions Repositories REST Endpoints
This section describes endpoints for Solutions Repositories management.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/repo/ /api/admin/repo/ | PUT | updateSolutionRepo | SolutionRepo | |||||
| /api/repo /api/admin/repo | POST | createSolutionRepo | SolutionRepo | |||||
| /api/repo/ /api/admin/repo/ | DELETE | deleteSolutionRepo | ||||||
| /api/repo /api/admin/repo | GET | PageSolutionRepo listSolutionRepos | SolutionRepoFilter PageOptions | |||||
| /api/repo//featured/ /api/admin/repo//featured/ | PUT | toggleFeatured | ||||||
| /api/repo//toggle/ /api/admin/repo//toggle/ | PUT | toggleSolution | ||||||
| /api/repo/ /api/admin/repo/ | GET | SolutionRepo getSolutionRepo | ||||||
| /api/repo /api/admin/repo | DELETE | deleteMany | [] |
Marketplace Solutions REST Endpoints
This section describes endpoints for Marketplace Solutions management.
Table below provides a quick summary:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/solution//featured /api/admin/solution//featured | PUT | featured | ||||||
| /api/solution//toggle /api/admin/solution//toggle | PUT | toggle | ||||||
| /api/solution /api/admin/solution | POST | createSolution | Solution | |||||
| /api/solution/ /api/admin/solution/ | PUT | updateSolution | Solution | |||||
| /api/solution/ /api/admin/solution/ | DELETE | deleteSolution | ||||||
| /api/solution /api/admin/solution | GET | PageSolution listSolutions | SolutionFilter PageOptions | |||||
| /api/solution /api/admin/solution | DELETE | deleteMany | [] | |||||
| /api/solution/ /api/admin/solution/ | GET | Solution getSolution |
VCS Endpoints
This section describes endpoints for VCS management.
Table below provides a quick summary:
VCSRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/vcs/ | GET | Vcs VcsRestController.getVcs | ||||||
| /api/vcs//repository | GET | []Repository VcsRestController.listRepositories | ||||||
| /api/vcs//ping | GET | VcsRestController.ping | ||||||
| /api/vcs/ | PUT | VcsRestController.updateVcs | Vcs | |||||
| /api/vcs//ident | GET | [] RepoIdent VcsRestController.listIdents | ||||||
| /api/vcs | GET | PageVcs VcsRestController.listsVcss | VcsFilter PageOptions | |||||
| /api/vcs/ | DELETE | VcsRestController.deleteVcs | ||||||
| /api/vcs | POST | VcsRestController.createVcs | Vcs | |||||
| /api/vcs | DELETE | VcsRestController.deleteMany | [] |
Repository Rest Endpoints
This section describes endpoints for Route management.
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/deploy//repository /api/admin/deploy//repository /api/deployment//repository /api/admin/deployment//repository | POST | addRepository | Repository | |||||
| /api/deploy//repository/ /api/admin/deploy//repository/ /api/deployment//repository/ /api/admin/deployment//repository/ | PUT | updateRepository | Repository | |||||
| /api/deploy//mount/ /api/admin/deploy//mount/ /api/deployment//mount/ /api/admin/deployment//mount/ | PUT | updateMount | Mount | |||||
| /api/deploy//mount /api/admin/deploy//mount /api/deployment//mount /api/admin/deployment//mount | POST | addMount | Mount | |||||
| /api/deploy//repository/ /api/admin/deploy//repository/ /api/deployment//repository/ /api/admin/deployment//repository/ | DELETE | deleteRepository | ||||||
| /api/deploy//repository /api/admin/deploy//repository /api/deployment//repository /api/admin/deployment//repository | GET | []Repository listRepositoriesFor |
Cluster REST Endpoints
This section describes endpoints for Cluster management.
Table below provides a quick summary:
ClusterRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/cluster//node/ /api/admin/cluster//node/ | GET | Node getNode | ||||||
| /api/cluster//env /api/admin/cluster//env | GET | Environment getEnv | ||||||
| /api/cluster//task/ /api/admin/cluster//task/ | DELETE | deleteClusterTask | ||||||
| /api/cluster//task/ /api/admin/cluster//task/ | PUT | updateClusterTask | ClusterTask | |||||
| /api/cluster//node/ /api/admin/cluster//node/ | PUT | updateNode | Node | |||||
| /api/cluster//node/ /api/admin/cluster//node/ | DELETE | deleteNode | ||||||
| /api/cluster//node /api/admin/cluster//node | POST | createNode | Node | |||||
| /api/cluster//task/ /api/admin/cluster//task/ | GET | ClusterTask getClusterTask | ||||||
| /api/cluster//env/ /api/admin/cluster//env/ | DELETE | deleteVariable | ||||||
| /api/cluster//env/ /api/admin/cluster//env/ | GET | Variable getVariable | ||||||
| /api/cluster//node /api/admin/cluster//node | GET | []Node listNodes | ||||||
| /api/cluster//env /api/admin/cluster//env | POST | addVariable | Variable | |||||
| /api/cluster//task /api/admin/cluster//task | GET | []ClusterTask listClusterTasks | ClusterTaskFilter | |||||
| /api/cluster//task /api/admin/cluster//task | POST | createClusterTask | ClusterTask | |||||
| /admin | GET | DashboardController.admin | ||||||
| /dashboard | GET | DashboardController.dashboard |
Billing Endpoints
This section describes endpoints for Billing management.
Table below provides a quick summary:
BillingController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/billing/ /api/admin/billing/ | PUT | Billing BillingRestController.putBilling | Billing | |||||
| /api/billing/ /api/admin/billing/ | DELETE | BillingRestController.deleteBilling | ||||||
| /api/billing/ /api/admin/billing/ | GET | Billing BillingRestController.getBilling | ||||||
| /api/billing//invite /api/admin/billing//invite | POST | BillingRestController.invite | Users |
License Endpoints
This section describes endpoints for License management.
Table below provides a quick summary:
SpaceRestController:
| Method | Path | Query Parameters | Request Body | Response Body | Status | Log | Security | Description |
|---|---|---|---|---|---|---|---|---|
| /api/license | POST | LicenseRestController.verifyLicense |
Imported REST Endpoints
This section describes endpoints setup by imported libraries.
- SSO Client (Java)
- Setting Util Library (Java)
Follow Us
Stay updated with latest news!
Subscribe to our newsletter...
Comments and Discussion