mcp-dokploy-fullapi-proxy 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yml +30 -0
- package/README.md +525 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +105 -0
- package/dist/index.js.map +1 -0
- package/package.json +28 -0
- package/skill/SKILL.md +76 -0
- package/skill/app.md +144 -0
- package/skill/compose.md +139 -0
- package/skill/database.md +339 -0
- package/skill/deployment.md +67 -0
- package/skill/docker.md +36 -0
- package/skill/dokploy-api.zip +0 -0
- package/skill/domain.md +49 -0
- package/skill/git.md +161 -0
- package/skill/infra.md +455 -0
- package/skill/notification.md +191 -0
- package/skill/project.md +65 -0
- package/skill/server.md +122 -0
- package/skill/settings.md +376 -0
- package/skill/user.md +140 -0
- package/src/index.ts +111 -0
- package/tsconfig.json +17 -0
package/skill/project.md
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# Project & Environment
|
|
2
|
+
|
|
3
|
+
## Project
|
|
4
|
+
|
|
5
|
+
### project.create
|
|
6
|
+
```
|
|
7
|
+
dokploy("project.create", { name: "...", description?: "...", env?: "..." })
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
### project.one
|
|
11
|
+
```
|
|
12
|
+
dokploy("project.one", { projectId: "..." })
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### project.all
|
|
16
|
+
```
|
|
17
|
+
dokploy("project.all")
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### project.remove
|
|
21
|
+
```
|
|
22
|
+
dokploy("project.remove", { projectId: "..." })
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### project.update
|
|
26
|
+
```
|
|
27
|
+
dokploy("project.update", { projectId: "...", name?: "...", description?: "...", createdAt?: "...", organizationId?: "...", env?: "..." })
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### project.duplicate
|
|
31
|
+
```
|
|
32
|
+
dokploy("project.duplicate", { sourceEnvironmentId: "...", name: "...", description?: "...", includeServices?: "...", selectedServices?: "...", duplicateInSameProject?: "..." })
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Environment
|
|
36
|
+
|
|
37
|
+
### environment.create
|
|
38
|
+
```
|
|
39
|
+
dokploy("environment.create", { name: "...", projectId: "...", description?: "..." })
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### environment.one
|
|
43
|
+
```
|
|
44
|
+
dokploy("environment.one", { environmentId: "..." })
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### environment.byProjectId
|
|
48
|
+
```
|
|
49
|
+
dokploy("environment.byProjectId", { projectId: "..." })
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### environment.remove
|
|
53
|
+
```
|
|
54
|
+
dokploy("environment.remove", { environmentId: "..." })
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### environment.update
|
|
58
|
+
```
|
|
59
|
+
dokploy("environment.update", { environmentId: "...", name?: "...", description?: "...", projectId?: "...", env?: "..." })
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### environment.duplicate
|
|
63
|
+
```
|
|
64
|
+
dokploy("environment.duplicate", { environmentId: "...", name: "...", description?: "..." })
|
|
65
|
+
```
|
package/skill/server.md
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
# Server, Cluster & Swarm
|
|
2
|
+
|
|
3
|
+
## Server
|
|
4
|
+
|
|
5
|
+
### server.create
|
|
6
|
+
```
|
|
7
|
+
dokploy("server.create", { name: "...", description: "...", ipAddress: "...", port: "...", username: "...", sshKeyId: "...", serverType: "..." })
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
### server.one
|
|
11
|
+
```
|
|
12
|
+
dokploy("server.one", { serverId: "..." })
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### server.getDefaultCommand
|
|
16
|
+
```
|
|
17
|
+
dokploy("server.getDefaultCommand", { serverId: "..." })
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### server.all
|
|
21
|
+
```
|
|
22
|
+
dokploy("server.all")
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### server.count
|
|
26
|
+
```
|
|
27
|
+
dokploy("server.count")
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### server.withSSHKey
|
|
31
|
+
```
|
|
32
|
+
dokploy("server.withSSHKey")
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### server.buildServers
|
|
36
|
+
```
|
|
37
|
+
dokploy("server.buildServers")
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### server.setup
|
|
41
|
+
```
|
|
42
|
+
dokploy("server.setup", { serverId: "..." })
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### server.validate
|
|
46
|
+
```
|
|
47
|
+
dokploy("server.validate", { serverId: "..." })
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### server.security
|
|
51
|
+
```
|
|
52
|
+
dokploy("server.security", { serverId: "..." })
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### server.setupMonitoring
|
|
56
|
+
```
|
|
57
|
+
dokploy("server.setupMonitoring", { serverId: "...", metricsConfig: "..." })
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### server.remove
|
|
61
|
+
```
|
|
62
|
+
dokploy("server.remove", { serverId: "..." })
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### server.update
|
|
66
|
+
```
|
|
67
|
+
dokploy("server.update", { name: "...", description: "...", serverId: "...", ipAddress: "...", port: "...", username: "...", sshKeyId: "...", serverType: "...", command?: "..." })
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### server.publicIp
|
|
71
|
+
```
|
|
72
|
+
dokploy("server.publicIp")
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### server.getServerTime
|
|
76
|
+
```
|
|
77
|
+
dokploy("server.getServerTime")
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### server.getServerMetrics
|
|
81
|
+
```
|
|
82
|
+
dokploy("server.getServerMetrics", { url: "...", token: "...", dataPoints: "..." })
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
## Cluster
|
|
86
|
+
|
|
87
|
+
### cluster.getNodes
|
|
88
|
+
```
|
|
89
|
+
dokploy("cluster.getNodes", { serverId?: "..." })
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### cluster.removeWorker
|
|
93
|
+
```
|
|
94
|
+
dokploy("cluster.removeWorker", { nodeId: "...", serverId?: "..." })
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### cluster.addWorker
|
|
98
|
+
```
|
|
99
|
+
dokploy("cluster.addWorker", { serverId?: "..." })
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### cluster.addManager
|
|
103
|
+
```
|
|
104
|
+
dokploy("cluster.addManager", { serverId?: "..." })
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Swarm
|
|
108
|
+
|
|
109
|
+
### swarm.getNodes
|
|
110
|
+
```
|
|
111
|
+
dokploy("swarm.getNodes", { serverId?: "..." })
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### swarm.getNodeInfo
|
|
115
|
+
```
|
|
116
|
+
dokploy("swarm.getNodeInfo", { nodeId: "...", serverId?: "..." })
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### swarm.getNodeApps
|
|
120
|
+
```
|
|
121
|
+
dokploy("swarm.getNodeApps", { serverId?: "..." })
|
|
122
|
+
```
|
|
@@ -0,0 +1,376 @@
|
|
|
1
|
+
# Settings, Admin & Stripe
|
|
2
|
+
|
|
3
|
+
## Settings
|
|
4
|
+
|
|
5
|
+
### settings.getWebServerSettings
|
|
6
|
+
```
|
|
7
|
+
dokploy("settings.getWebServerSettings")
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
### settings.reloadServer
|
|
11
|
+
```
|
|
12
|
+
dokploy("settings.reloadServer")
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### settings.cleanRedis
|
|
16
|
+
```
|
|
17
|
+
dokploy("settings.cleanRedis")
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### settings.reloadRedis
|
|
21
|
+
```
|
|
22
|
+
dokploy("settings.reloadRedis")
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### settings.cleanAllDeploymentQueue
|
|
26
|
+
```
|
|
27
|
+
dokploy("settings.cleanAllDeploymentQueue")
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### settings.reloadTraefik
|
|
31
|
+
```
|
|
32
|
+
dokploy("settings.reloadTraefik", { serverId?: "..." })
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### settings.toggleDashboard
|
|
36
|
+
```
|
|
37
|
+
dokploy("settings.toggleDashboard", { enableDashboard?: "...", serverId?: "..." })
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### settings.cleanUnusedImages
|
|
41
|
+
```
|
|
42
|
+
dokploy("settings.cleanUnusedImages", { serverId?: "..." })
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### settings.cleanUnusedVolumes
|
|
46
|
+
```
|
|
47
|
+
dokploy("settings.cleanUnusedVolumes", { serverId?: "..." })
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### settings.cleanStoppedContainers
|
|
51
|
+
```
|
|
52
|
+
dokploy("settings.cleanStoppedContainers", { serverId?: "..." })
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### settings.cleanDockerBuilder
|
|
56
|
+
```
|
|
57
|
+
dokploy("settings.cleanDockerBuilder", { serverId?: "..." })
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### settings.cleanDockerPrune
|
|
61
|
+
```
|
|
62
|
+
dokploy("settings.cleanDockerPrune", { serverId?: "..." })
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### settings.cleanAll
|
|
66
|
+
```
|
|
67
|
+
dokploy("settings.cleanAll", { serverId?: "..." })
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### settings.cleanMonitoring
|
|
71
|
+
```
|
|
72
|
+
dokploy("settings.cleanMonitoring")
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### settings.saveSSHPrivateKey
|
|
76
|
+
```
|
|
77
|
+
dokploy("settings.saveSSHPrivateKey", { sshPrivateKey: "..." })
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### settings.assignDomainServer
|
|
81
|
+
```
|
|
82
|
+
dokploy("settings.assignDomainServer", { host: "...", certificateType: "...", letsEncryptEmail?: "...", https?: "..." })
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### settings.cleanSSHPrivateKey
|
|
86
|
+
```
|
|
87
|
+
dokploy("settings.cleanSSHPrivateKey")
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### settings.updateDockerCleanup
|
|
91
|
+
```
|
|
92
|
+
dokploy("settings.updateDockerCleanup", { enableDockerCleanup: "...", serverId?: "..." })
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### settings.readTraefikConfig
|
|
96
|
+
```
|
|
97
|
+
dokploy("settings.readTraefikConfig")
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### settings.updateTraefikConfig
|
|
101
|
+
```
|
|
102
|
+
dokploy("settings.updateTraefikConfig", { traefikConfig: "..." })
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### settings.readWebServerTraefikConfig
|
|
106
|
+
```
|
|
107
|
+
dokploy("settings.readWebServerTraefikConfig")
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### settings.updateWebServerTraefikConfig
|
|
111
|
+
```
|
|
112
|
+
dokploy("settings.updateWebServerTraefikConfig", { traefikConfig: "..." })
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
### settings.readMiddlewareTraefikConfig
|
|
116
|
+
```
|
|
117
|
+
dokploy("settings.readMiddlewareTraefikConfig")
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### settings.updateMiddlewareTraefikConfig
|
|
121
|
+
```
|
|
122
|
+
dokploy("settings.updateMiddlewareTraefikConfig", { traefikConfig: "..." })
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### settings.getUpdateData
|
|
126
|
+
```
|
|
127
|
+
dokploy("settings.getUpdateData")
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### settings.updateServer
|
|
131
|
+
```
|
|
132
|
+
dokploy("settings.updateServer")
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
### settings.getDokployVersion
|
|
136
|
+
```
|
|
137
|
+
dokploy("settings.getDokployVersion")
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### settings.getReleaseTag
|
|
141
|
+
```
|
|
142
|
+
dokploy("settings.getReleaseTag")
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### settings.readDirectories
|
|
146
|
+
```
|
|
147
|
+
dokploy("settings.readDirectories", { serverId?: "..." })
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### settings.updateTraefikFile
|
|
151
|
+
```
|
|
152
|
+
dokploy("settings.updateTraefikFile", { path: "...", traefikConfig: "...", serverId?: "..." })
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
### settings.readTraefikFile
|
|
156
|
+
```
|
|
157
|
+
dokploy("settings.readTraefikFile", { path: "...", serverId?: "..." })
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### settings.getIp
|
|
161
|
+
```
|
|
162
|
+
dokploy("settings.getIp")
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### settings.updateServerIp
|
|
166
|
+
```
|
|
167
|
+
dokploy("settings.updateServerIp", { serverIp: "..." })
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### settings.getOpenApiDocument
|
|
171
|
+
```
|
|
172
|
+
dokploy("settings.getOpenApiDocument")
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### settings.readTraefikEnv
|
|
176
|
+
```
|
|
177
|
+
dokploy("settings.readTraefikEnv", { serverId?: "..." })
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### settings.writeTraefikEnv
|
|
181
|
+
```
|
|
182
|
+
dokploy("settings.writeTraefikEnv", { env: "...", serverId?: "..." })
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
### settings.haveTraefikDashboardPortEnabled
|
|
186
|
+
```
|
|
187
|
+
dokploy("settings.haveTraefikDashboardPortEnabled", { serverId?: "..." })
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
### settings.haveActivateRequests
|
|
191
|
+
```
|
|
192
|
+
dokploy("settings.haveActivateRequests")
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### settings.toggleRequests
|
|
196
|
+
```
|
|
197
|
+
dokploy("settings.toggleRequests", { enable: "..." })
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### settings.isCloud
|
|
201
|
+
```
|
|
202
|
+
dokploy("settings.isCloud")
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
### settings.isUserSubscribed
|
|
206
|
+
```
|
|
207
|
+
dokploy("settings.isUserSubscribed")
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### settings.health
|
|
211
|
+
```
|
|
212
|
+
dokploy("settings.health")
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### settings.setupGPU
|
|
216
|
+
```
|
|
217
|
+
dokploy("settings.setupGPU", { serverId?: "..." })
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
### settings.checkGPUStatus
|
|
221
|
+
```
|
|
222
|
+
dokploy("settings.checkGPUStatus", { serverId?: "..." })
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
### settings.updateTraefikPorts
|
|
226
|
+
```
|
|
227
|
+
dokploy("settings.updateTraefikPorts", { additionalPorts: "...", serverId?: "..." })
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### settings.getTraefikPorts
|
|
231
|
+
```
|
|
232
|
+
dokploy("settings.getTraefikPorts", { serverId?: "..." })
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### settings.updateLogCleanup
|
|
236
|
+
```
|
|
237
|
+
dokploy("settings.updateLogCleanup", { cronExpression: "..." })
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
### settings.getLogCleanupStatus
|
|
241
|
+
```
|
|
242
|
+
dokploy("settings.getLogCleanupStatus")
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
### settings.getDokployCloudIps
|
|
246
|
+
```
|
|
247
|
+
dokploy("settings.getDokployCloudIps")
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
## Admin
|
|
251
|
+
|
|
252
|
+
### admin.setupMonitoring
|
|
253
|
+
```
|
|
254
|
+
dokploy("admin.setupMonitoring", { metricsConfig: "..." })
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
## Stripe
|
|
258
|
+
|
|
259
|
+
### stripe.getCurrentPlan
|
|
260
|
+
```
|
|
261
|
+
dokploy("stripe.getCurrentPlan")
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### stripe.getProducts
|
|
265
|
+
```
|
|
266
|
+
dokploy("stripe.getProducts")
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### stripe.createCheckoutSession
|
|
270
|
+
```
|
|
271
|
+
dokploy("stripe.createCheckoutSession", { tier: "...", productId: "...", serverQuantity: "...", isAnnual: "..." })
|
|
272
|
+
```
|
|
273
|
+
|
|
274
|
+
### stripe.createCustomerPortalSession
|
|
275
|
+
```
|
|
276
|
+
dokploy("stripe.createCustomerPortalSession")
|
|
277
|
+
```
|
|
278
|
+
|
|
279
|
+
### stripe.upgradeSubscription
|
|
280
|
+
```
|
|
281
|
+
dokploy("stripe.upgradeSubscription", { tier: "...", serverQuantity: "...", isAnnual: "..." })
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### stripe.canCreateMoreServers
|
|
285
|
+
```
|
|
286
|
+
dokploy("stripe.canCreateMoreServers")
|
|
287
|
+
```
|
|
288
|
+
|
|
289
|
+
### stripe.getInvoices
|
|
290
|
+
```
|
|
291
|
+
dokploy("stripe.getInvoices")
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
## Sso
|
|
295
|
+
|
|
296
|
+
### sso.showSignInWithSSO
|
|
297
|
+
```
|
|
298
|
+
dokploy("sso.showSignInWithSSO")
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### sso.listProviders
|
|
302
|
+
```
|
|
303
|
+
dokploy("sso.listProviders")
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### sso.getTrustedOrigins
|
|
307
|
+
```
|
|
308
|
+
dokploy("sso.getTrustedOrigins")
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### sso.one
|
|
312
|
+
```
|
|
313
|
+
dokploy("sso.one", { providerId: "..." })
|
|
314
|
+
```
|
|
315
|
+
|
|
316
|
+
### sso.update
|
|
317
|
+
```
|
|
318
|
+
dokploy("sso.update", { providerId: "...", issuer: "...", domains: "...", oidcConfig?: "...", samlConfig?: "...", organizationId?: "...", overrideUserInfo?: "..." })
|
|
319
|
+
```
|
|
320
|
+
|
|
321
|
+
### sso.deleteProvider
|
|
322
|
+
```
|
|
323
|
+
dokploy("sso.deleteProvider", { providerId: "..." })
|
|
324
|
+
```
|
|
325
|
+
|
|
326
|
+
### sso.register
|
|
327
|
+
```
|
|
328
|
+
dokploy("sso.register", { providerId: "...", issuer: "...", domains: "...", oidcConfig?: "...", samlConfig?: "...", organizationId?: "...", overrideUserInfo?: "..." })
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### sso.addTrustedOrigin
|
|
332
|
+
```
|
|
333
|
+
dokploy("sso.addTrustedOrigin", { origin: "..." })
|
|
334
|
+
```
|
|
335
|
+
|
|
336
|
+
### sso.removeTrustedOrigin
|
|
337
|
+
```
|
|
338
|
+
dokploy("sso.removeTrustedOrigin", { origin: "..." })
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
### sso.updateTrustedOrigin
|
|
342
|
+
```
|
|
343
|
+
dokploy("sso.updateTrustedOrigin", { oldOrigin: "...", newOrigin: "..." })
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
## Licensekey
|
|
347
|
+
|
|
348
|
+
### licenseKey.activate
|
|
349
|
+
```
|
|
350
|
+
dokploy("licenseKey.activate", { licenseKey: "..." })
|
|
351
|
+
```
|
|
352
|
+
|
|
353
|
+
### licenseKey.validate
|
|
354
|
+
```
|
|
355
|
+
dokploy("licenseKey.validate")
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### licenseKey.deactivate
|
|
359
|
+
```
|
|
360
|
+
dokploy("licenseKey.deactivate")
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### licenseKey.getEnterpriseSettings
|
|
364
|
+
```
|
|
365
|
+
dokploy("licenseKey.getEnterpriseSettings")
|
|
366
|
+
```
|
|
367
|
+
|
|
368
|
+
### licenseKey.haveValidLicenseKey
|
|
369
|
+
```
|
|
370
|
+
dokploy("licenseKey.haveValidLicenseKey")
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
### licenseKey.updateEnterpriseSettings
|
|
374
|
+
```
|
|
375
|
+
dokploy("licenseKey.updateEnterpriseSettings", { enableEnterpriseFeatures?: "..." })
|
|
376
|
+
```
|
package/skill/user.md
ADDED
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# User & Organization
|
|
2
|
+
|
|
3
|
+
## User
|
|
4
|
+
|
|
5
|
+
### user.all
|
|
6
|
+
```
|
|
7
|
+
dokploy("user.all")
|
|
8
|
+
```
|
|
9
|
+
|
|
10
|
+
### user.one
|
|
11
|
+
```
|
|
12
|
+
dokploy("user.one", { userId: "..." })
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
### user.get
|
|
16
|
+
```
|
|
17
|
+
dokploy("user.get")
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
### user.haveRootAccess
|
|
21
|
+
```
|
|
22
|
+
dokploy("user.haveRootAccess")
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
### user.getBackups
|
|
26
|
+
```
|
|
27
|
+
dokploy("user.getBackups")
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
### user.getServerMetrics
|
|
31
|
+
```
|
|
32
|
+
dokploy("user.getServerMetrics")
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### user.update
|
|
36
|
+
```
|
|
37
|
+
dokploy("user.update", { id?: "...", firstName?: "...", lastName?: "...", isRegistered?: "...", expirationDate?: "...", createdAt2?: "...", createdAt?: "...", twoFactorEnabled?: "...", email?: "...", emailVerified?: "...", image?: "...", banned?: "...", banReason?: "...", banExpires?: "...", updatedAt?: "...", enablePaidFeatures?: "...", allowImpersonation?: "...", enableEnterpriseFeatures?: "...", licenseKey?: "...", stripeCustomerId?: "...", stripeSubscriptionId?: "...", serversQuantity?: "...", password?: "...", currentPassword?: "..." })
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### user.getUserByToken
|
|
41
|
+
```
|
|
42
|
+
dokploy("user.getUserByToken", { token: "..." })
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### user.getMetricsToken
|
|
46
|
+
```
|
|
47
|
+
dokploy("user.getMetricsToken")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### user.remove
|
|
51
|
+
```
|
|
52
|
+
dokploy("user.remove", { userId: "..." })
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### user.assignPermissions
|
|
56
|
+
```
|
|
57
|
+
dokploy("user.assignPermissions", { id: "...", accessedProjects: "...", accessedEnvironments: "...", accessedServices: "...", canCreateProjects: "...", canCreateServices: "...", canDeleteProjects: "...", canDeleteServices: "...", canAccessToDocker: "...", canAccessToTraefikFiles: "...", canAccessToAPI: "...", canAccessToSSHKeys: "...", canAccessToGitProviders: "...", canDeleteEnvironments: "...", canCreateEnvironments: "..." })
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
### user.getInvitations
|
|
61
|
+
```
|
|
62
|
+
dokploy("user.getInvitations")
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### user.getContainerMetrics
|
|
66
|
+
```
|
|
67
|
+
dokploy("user.getContainerMetrics", { url: "...", token: "...", appName: "...", dataPoints: "..." })
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### user.generateToken
|
|
71
|
+
```
|
|
72
|
+
dokploy("user.generateToken")
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### user.deleteApiKey
|
|
76
|
+
```
|
|
77
|
+
dokploy("user.deleteApiKey", { apiKeyId: "..." })
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### user.createApiKey
|
|
81
|
+
```
|
|
82
|
+
dokploy("user.createApiKey", { name: "...", metadata: "...", prefix?: "...", expiresIn?: "...", rateLimitEnabled?: "...", rateLimitTimeWindow?: "...", rateLimitMax?: "...", remaining?: "...", refillAmount?: "...", refillInterval?: "..." })
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### user.checkUserOrganizations
|
|
86
|
+
```
|
|
87
|
+
dokploy("user.checkUserOrganizations", { userId: "..." })
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### user.sendInvitation
|
|
91
|
+
```
|
|
92
|
+
dokploy("user.sendInvitation", { invitationId: "...", notificationId: "..." })
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
## Organization
|
|
96
|
+
|
|
97
|
+
### organization.create
|
|
98
|
+
```
|
|
99
|
+
dokploy("organization.create", { name: "...", logo?: "..." })
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### organization.all
|
|
103
|
+
```
|
|
104
|
+
dokploy("organization.all")
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
### organization.one
|
|
108
|
+
```
|
|
109
|
+
dokploy("organization.one", { organizationId: "..." })
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### organization.update
|
|
113
|
+
```
|
|
114
|
+
dokploy("organization.update", { organizationId: "...", name: "...", logo?: "..." })
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
### organization.delete
|
|
118
|
+
```
|
|
119
|
+
dokploy("organization.delete", { organizationId: "..." })
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### organization.allInvitations
|
|
123
|
+
```
|
|
124
|
+
dokploy("organization.allInvitations")
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### organization.removeInvitation
|
|
128
|
+
```
|
|
129
|
+
dokploy("organization.removeInvitation", { invitationId: "..." })
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### organization.updateMemberRole
|
|
133
|
+
```
|
|
134
|
+
dokploy("organization.updateMemberRole", { memberId: "...", role: "..." })
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### organization.setDefault
|
|
138
|
+
```
|
|
139
|
+
dokploy("organization.setDefault", { organizationId: "..." })
|
|
140
|
+
```
|