Appwrite Client is the client-side interface for using Appwrite, an open-source backend platform for authentication, databases, storage, and app services.
Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.
appwritedeveloper-devops
Appwrite Client
Appwrite Client is the client-side interface for using Appwrite, an open-source backend platform for authentication, databases, storage, and app services.
Base URL: https://appwrite.io/v1
Auth: header:X-Appwrite-JWT (pass your key via the apiKey input)
Operations
accountget — GET /account — Get Account
accountgetlogs — GET /account/logs — Get Account Logs
accountgetprefs — GET /account/prefs — Get Account Preferences
accountgetsessions — GET /account/sessions — Get Account Sessions
accountcreateoauth2session — GET /account/sessions/oauth2/{provider} — Create Account Session with OAuth2
accountgetsession — GET /account/sessions/{sessionId} — Get Session By ID
Inputs
apiKey — your appwrite-client API key
operation — one of the operations above
path parameters when an operation's path contains {...}
query — optional JSON object of query params
body — JSON object for create/update ops
Example
operation: accountget
apiKey: <your key>
Publishes
The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.
error
operation
result
status
Input Properties
Every property this tool accepts, from its own tool.iml.
Property
Type
Required
Default
Description
apiKey
string
yes
—
DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
operation
string
yes
—
One of: accountget, accountgetlogs, accountgetprefs, accountgetsessions, accountcreateoauth2session, accountgetsession
provider
string
no
—
Path parameter provider (required by some operations).
sessionId
string
no
—
Path parameter sessionId (required by some operations).
query
string
no
—
Optional query params as a JSON object string, e.g. {"limit": 10}.