🎛️
Lowcoder API Specification
  • Authentication
  • API reference Lowcoder
    • Api Lowcoder v2.0.1
      • Users
        • Password
        • NewUserGuidanceShown
        • Mark status
        • Reset password
        • Photo
        • UserDetail
        • Me
        • CurrentUser
      • Datasources
        • Permissions
        • Test
        • GetPluginDynamicConfig
        • Structure
        • ListByOrg
        • ListByApp
        • JsDatasourcePlugins
        • Info
      • Applications
        • Public to all
        • Permissions
        • Restore
        • Recycle
          • List
        • Publish
        • CreateFromTemplate
        • View
        • List
        • Home
      • Library queries
        • Publish
        • ListByOrg
        • DropDownList
      • Folders
        • Permissions
        • Move
        • Elements
      • Organizations
        • Update
        • Role
        • Common settings
        • SwitchOrganization
        • Logo
        • Members
        • DatasourceTypes
        • Remove
        • Leave
      • Invitation
        • Invite
      • Groups
        • Update
        • Role
        • AddMember
        • Members
        • List
        • Remove
        • Leave
      • Configs
        • DeploymentId
      • Materials
        • List
      • Assets
      • Library query records
        • ListByLibraryQueryId
      • Query
        • Execute from node
        • Execute
      • Auth
        • Logout
        • Config
        • Configs
        • Tp
          • Login
        • Form
          • Login
      • Application
        • History snapshots
      • State
        • HealthCheck
      • Misc
        • Js library
          • Recommendations
          • Metas
      • Specification
    • Api Lowcoder v2.1.4
      • Users
        • Password
        • NewUserGuidanceShown
        • Mark status
        • Reset password
        • Photo
        • UserDetail
        • Me
        • CurrentUser
      • Datasources
        • Permissions
        • Test
        • GetPluginDynamicConfig
        • Structure
        • ListByOrg
        • ListByApp
        • JsDatasourcePlugins
        • Info
      • Applications
        • Public to all
        • Permissions
        • Restore
        • Recycle
          • List
        • Publish
        • CreateFromTemplate
        • View
        • List
        • Home
      • Library queries
        • Publish
        • ListByOrg
        • DropDownList
      • Folders
        • Permissions
        • Move
        • Elements
      • Organizations
        • Update
        • Role
        • Common settings
        • SwitchOrganization
        • Logo
        • Members
        • DatasourceTypes
        • Remove
        • Leave
      • Invitation
        • Invite
      • Groups
        • Update
        • Role
        • AddMember
        • Members
        • List
        • Remove
        • Leave
      • Configs
        • DeploymentId
      • Materials
        • List
      • Assets
      • Library query records
        • ListByLibraryQueryId
      • Query
        • Execute from node
        • Execute
      • Auth
        • Logout
        • Config
        • Configs
        • Tp
          • Login
        • Form
          • Login
      • Application
        • History snapshots
      • State
        • HealthCheck
      • Misc
        • Js library
          • Recommendations
          • Metas
      • Specification
    • API Lowcoder v2.1.6
      • Users
        • Password
        • NewUserGuidanceShown
        • Mark status
        • Reset password
        • Photo
        • UserDetail
        • Me
        • CurrentUser
      • Datasources
        • Permissions
        • Test
        • GetPluginDynamicConfig
        • Structure
        • ListByOrg
        • ListByApp
        • JsDatasourcePlugins
        • Info
      • Applications
        • Public to all
        • Permissions
        • Restore
        • Recycle
          • List
        • Publish
        • CreateFromTemplate
        • View
        • List
        • Home
      • Library queries
        • Publish
        • ListByOrg
        • DropDownList
      • Folders
        • Permissions
        • Move
        • Elements
      • Organizations
        • Update
        • Role
        • Common settings
        • SwitchOrganization
        • Logo
        • Members
        • DatasourceTypes
        • Remove
        • Leave
      • Groups
        • Update
        • Role
        • AddMember
        • Members
        • List
        • Remove
        • Leave
      • Configs
        • DeploymentId
      • Invitation
        • Invite
      • Materials
        • List
      • Assets
      • Library query records
        • ListByLibraryQueryId
      • Query
        • Execute from node
        • Execute
      • Application
        • History snapshots
      • Misc
        • Js library
          • Recommendations
          • Metas
      • Auth
        • Logout
        • Config
        • Api key
        • Configs
        • Api keys
        • Tp
          • Login
        • Form
          • Login
      • State
        • HealthCheck
    • Specification
Powered by GitBook
On this page
  • Single Docker Deployment
  • Multi-Docker Deployment
  • app.lowcoder.cloud

API reference Lowcoder

PreviousAuthenticationNextApi Lowcoder v2.0.1

Last updated 2 months ago

The Base URL of the Lowcoder API depends on your installation.

Single Docker Deployment

The Base URL of the API is the same as for the Frontend. In local installations for example:

http://localhost:3000/
https://<yourdomain>:3000/
https://<yourdomain>/

Multi-Docker Deployment

In a Multi-Docker Deployment, you will have an individual IP address or Domain for the API-Service Container. This is then the Base URL for the Lowcoder API.

https://<your-api-service-domain>:8080/
https://<your-api-service-domain>/

When you run Multi-Docker Deployment on Localhost, you will need to look for the that apply to your setup.

app.lowcoder.cloud

To use the API of the Cloud Version, the API is to reach via the separate API Service.

https://api-service.lowcoder.cloud/

Since Lowcoder v2.1.6 we publish the OpenAPI Specification and the Swagger Documentation automatically.

Swagger Documentation: <Lowcoder-Location>/api/docs/webjars/swagger-ui/index.html#
OpenAPI Specification: <Lowcoder-Location>/api/docs/openapi.json

You can find the current API Documentation for example here:

Bridge-Network Settings
https://api-service.lowcoder.cloud/api/docs/webjars/swagger-ui/index.html#/