You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/functions.md
-24Lines changed: 0 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,5 @@
1
1
# Functions Service
2
2
3
-
## List functions
4
3
5
4
```http request
6
5
GET https://cloud.appwrite.io/v1/functions
@@ -15,7 +14,6 @@ GET https://cloud.appwrite.io/v1/functions
15
14
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId |[]|
16
15
| search | string | Search term to filter your list results. Max length: 256 chars. ||
17
16
18
-
## Create function
19
17
20
18
```http request
21
19
POST https://cloud.appwrite.io/v1/functions
@@ -50,15 +48,13 @@ POST https://cloud.appwrite.io/v1/functions
50
48
| templateVersion | string | Version (tag) for the repo linked to the function template. ||
51
49
| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
52
50
53
-
## List runtimes
54
51
55
52
```http request
56
53
GET https://cloud.appwrite.io/v1/functions/runtimes
57
54
```
58
55
59
56
** Get a list of all runtimes that are currently active on your instance. **
60
57
61
-
## List available function runtime specifications
62
58
63
59
```http request
64
60
GET https://cloud.appwrite.io/v1/functions/specifications
@@ -67,7 +63,6 @@ GET https://cloud.appwrite.io/v1/functions/specifications
67
63
** List allowed function specifications for this instance.
68
64
**
69
65
70
-
## Get function
71
66
72
67
```http request
73
68
GET https://cloud.appwrite.io/v1/functions/{functionId}
@@ -81,7 +76,6 @@ GET https://cloud.appwrite.io/v1/functions/{functionId}
81
76
| --- | --- | --- | --- |
82
77
| functionId | string |**Required** Function ID. ||
83
78
84
-
## Update function
85
79
86
80
```http request
87
81
PUT https://cloud.appwrite.io/v1/functions/{functionId}
@@ -112,7 +106,6 @@ PUT https://cloud.appwrite.io/v1/functions/{functionId}
112
106
| providerRootDirectory | string | Path to function code in the linked repo. ||
113
107
| specification | string | Runtime specification for the function and builds. | s-1vcpu-512mb |
| functionId | string |**Required** Function ID. ||
128
121
129
-
## List deployments
130
122
131
123
```http request
132
124
GET https://cloud.appwrite.io/v1/functions/{functionId}/deployments
@@ -142,7 +134,6 @@ GET https://cloud.appwrite.io/v1/functions/{functionId}/deployments
142
134
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size |[]|
143
135
| search | string | Search term to filter your list results. Max length: 256 chars. ||
144
136
145
-
## Create deployment
146
137
147
138
```http request
148
139
POST https://cloud.appwrite.io/v1/functions/{functionId}/deployments
@@ -164,7 +155,6 @@ Use the "command" param to set the entrypoint used to execute your cod
164
155
| code | file | Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory. ||
165
156
| activate | boolean | Automatically activate the deployment when it is finished building. ||
166
157
167
-
## Get deployment
168
158
169
159
```http request
170
160
GET https://cloud.appwrite.io/v1/functions/{functionId}/deployments/{deploymentId}
@@ -179,7 +169,6 @@ GET https://cloud.appwrite.io/v1/functions/{functionId}/deployments/{deploymentI
179
169
| functionId | string |**Required** Function ID. ||
GET https://cloud.appwrite.io/v1/functions/{functionId}/executions
@@ -271,7 +255,6 @@ GET https://cloud.appwrite.io/v1/functions/{functionId}/executions
271
255
| queries | array | Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId |[]|
272
256
| search | string | Search term to filter your list results. Max length: 256 chars. ||
273
257
274
-
## Create execution
275
258
276
259
```http request
277
260
POST https://cloud.appwrite.io/v1/functions/{functionId}/executions
@@ -291,7 +274,6 @@ POST https://cloud.appwrite.io/v1/functions/{functionId}/executions
291
274
| headers | object | HTTP headers of execution. Defaults to empty. | {} |
292
275
| scheduledAt | string | Scheduled execution time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes. ||
293
276
294
-
## Get execution
295
277
296
278
```http request
297
279
GET https://cloud.appwrite.io/v1/functions/{functionId}/executions/{executionId}
@@ -306,7 +288,6 @@ GET https://cloud.appwrite.io/v1/functions/{functionId}/executions/{executionId}
306
288
| functionId | string |**Required** Function ID. ||
0 commit comments