Can I use Directus as a CLI?

Yes. KosmoKrator exposes a Directus CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Directus through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Directus tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Directus credentials stored?

Directus credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Directus MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Directus Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Directus KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.directus.*. Use lua_read_doc("integrations.directus") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Directus workflow without starting an interactive agent session.

Inline Lua call

kosmo integrations:lua --eval 'dump(app.integrations.directus.list_activity_actions({}))' --json

Read Lua docs headlessly

kosmo integrations:lua --eval 'print(docs.read("directus"))' --json
kosmo integrations:lua --eval 'print(docs.read("directus.list_activity_actions"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua

local directus = app.integrations.directus
local result = directus.list_activity_actions({})

dump(result)

Run the workflow

kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json

Namespace note. integrations:lua exposes app.integrations.directus, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.directus.default.* or app.integrations.directus.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Directus, use the narrower mcp:lua command.

MCP Lua command

# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Directus Lua Docs

Namespace: directus

Directus tools call the official Directus REST API. Configure an instance URL and an access token before using protected endpoints. Public authentication and health endpoints are also exposed from the official OpenAPI source.

The integration now mirrors the official Directus OpenAPI package, including tools for activity, assets, authentication, items, presets, collections, comments, extensions, fields, files, flows, folders, operations, permissions, relations, revisions, roles, schema, server info, settings, users, utilities, and content versions.

Common tools:

local items = directus.directus_list_items({
  collection = "articles",
  limit = 10,
  fields = { "id", "title", "status" }
})

local article = directus.directus_get_item({
  collection = "articles",
  id = "example-id"
})

local created = directus.directus_create_item({
  collection = "articles",
  body = {
    title = "Example",
    status = "draft"
  }
})

Request bodies can be passed as a body object. For JSON endpoints, loose arguments that are not path, query, or header parameters are also sent as the request body.

Directus returns most successful responses as { data = ... } and may include meta for list endpoints when requested. Non-JSON responses, such as binary asset responses or exports, are returned as { body = "...", content_type = "..." }.

Use fake collection names, ids, and instance URLs in examples and tests. Do not store real Directus tokens in Lua scripts or committed fixtures.

Raw agent markdown

# Directus Lua Docs

Namespace: `directus`

Directus tools call the official Directus REST API. Configure an instance URL and an access token before using protected endpoints. Public authentication and health endpoints are also exposed from the official OpenAPI source.

The integration now mirrors the official Directus OpenAPI package, including tools for activity, assets, authentication, items, presets, collections, comments, extensions, fields, files, flows, folders, operations, permissions, relations, revisions, roles, schema, server info, settings, users, utilities, and content versions.

Common tools:

```lua
local items = directus.directus_list_items({
  collection = "articles",
  limit = 10,
  fields = { "id", "title", "status" }
})

local article = directus.directus_get_item({
  collection = "articles",
  id = "example-id"
})

local created = directus.directus_create_item({
  collection = "articles",
  body = {
    title = "Example",
    status = "draft"
  }
})
```

Request bodies can be passed as a `body` object. For JSON endpoints, loose arguments that are not path, query, or header parameters are also sent as the request body.

Directus returns most successful responses as `{ data = ... }` and may include `meta` for list endpoints when requested. Non-JSON responses, such as binary asset responses or exports, are returned as `{ body = "...", content_type = "..." }`.

Use fake collection names, ids, and instance URLs in examples and tests. Do not store real Directus tokens in Lua scripts or committed fixtures.

Metadata-derived Lua example

local result = app.integrations.directus.list_activity_actions({})
print(result)

Functions

list_activity_actions Read

Returns a list of activity actions.

Lua path: app.integrations.directus.list_activity_actions
Full name: directus.directus_get_activities

Parameter	Type	Required	Description
No parameters.

retrieve_activity_action Read

Retrieves the details of an existing activity action. Provide the primary key of the activity action and Directus will return the corresponding information.

Lua path: app.integrations.directus.retrieve_activity_action
Full name: directus.directus_get_activity

Parameter	Type	Required	Description
No parameters.

get_asset Read

Image typed files can be dynamically resized and transformed to fit any need.

Lua path: app.integrations.directus.get_asset
Full name: directus.directus_get_asset

Parameter	Type	Required	Description
No parameters.

retrieve_temporary_access_token Write

Retrieve a Temporary Access Token

Lua path: app.integrations.directus.retrieve_temporary_access_token
Full name: directus.directus_login

Parameter	Type	Required	Description
No parameters.

refresh_token Write

Refresh a Temporary Access Token.

Lua path: app.integrations.directus.refresh_token
Full name: directus.directus_refresh

Parameter	Type	Required	Description
No parameters.

log_out Write

Log Out

Lua path: app.integrations.directus.log_out
Full name: directus.directus_logout

Parameter	Type	Required	Description
No parameters.

request_password_reset Write

Request that a password reset email be sent. This does not apply to users authenticated through external providers OAuth, SAML, LDAP, etc..

Lua path: app.integrations.directus.request_password_reset
Full name: directus.directus_password_request

Parameter	Type	Required	Description
No parameters.

reset_password Write

The request a password reset endpoint sends an email with a link to the admin app which in turn uses this endpoint to allow the user to reset their password.

Lua path: app.integrations.directus.reset_password
Full name: directus.directus_password_reset

Parameter	Type	Required	Description
No parameters.

list_oauth_providers Read

List configured OAuth providers.

Lua path: app.integrations.directus.list_oauth_providers
Full name: directus.directus_oauth

Parameter	Type	Required	Description
No parameters.

authenticated_using_oauth_provider Read

Start OAuth flow using the specified provider

Lua path: app.integrations.directus.authenticated_using_oauth_provider
Full name: directus.directus_oauth_provider

Parameter	Type	Required	Description
No parameters.

list_items Read

List the items.

Lua path: app.integrations.directus.list_items
Full name: directus.directus_list_items

Parameter	Type	Required	Description
No parameters.

create_item Write

Create a new item.

Lua path: app.integrations.directus.create_item
Full name: directus.directus_create_item

Parameter	Type	Required	Description
No parameters.

update_multiple_items Write

Update multiple items at the same time.

Lua path: app.integrations.directus.update_multiple_items
Full name: directus.directus_update_items

Parameter	Type	Required	Description
No parameters.

delete_multiple_items Write

Delete multiple existing items.

Lua path: app.integrations.directus.delete_multiple_items
Full name: directus.directus_delete_items

Parameter	Type	Required	Description
No parameters.

retrieve_item Read

Retrieve a single item by unique identifier.

Lua path: app.integrations.directus.retrieve_item
Full name: directus.directus_get_item

Parameter	Type	Required	Description
No parameters.

update_item Write

Update an existing item.

Lua path: app.integrations.directus.update_item
Full name: directus.directus_update_item

Parameter	Type	Required	Description
No parameters.

delete_item Write

Delete an existing item.

Lua path: app.integrations.directus.delete_item
Full name: directus.directus_delete_item

Parameter	Type	Required	Description
No parameters.

list_presets Read

List the presets.

Lua path: app.integrations.directus.list_presets
Full name: directus.directus_get_presets

Parameter	Type	Required	Description
No parameters.

create_preset Write

Create a new preset.

Lua path: app.integrations.directus.create_preset
Full name: directus.directus_create_preset

Parameter	Type	Required	Description
No parameters.

update_multiple_presets Write

Update multiple presets at the same time.

Lua path: app.integrations.directus.update_multiple_presets
Full name: directus.directus_update_presets

Parameter	Type	Required	Description
No parameters.

delete_multiple_presets Write

Delete multiple existing presets.

Lua path: app.integrations.directus.delete_multiple_presets
Full name: directus.directus_delete_presets

Parameter	Type	Required	Description
No parameters.

retrieve_preset Read

Retrieve a single preset by unique identifier.

Lua path: app.integrations.directus.retrieve_preset
Full name: directus.directus_get_preset

Parameter	Type	Required	Description
No parameters.

update_preset Write

Update an existing preset.

Lua path: app.integrations.directus.update_preset
Full name: directus.directus_update_preset

Parameter	Type	Required	Description
No parameters.

delete_preset Write

Delete an existing preset.

Lua path: app.integrations.directus.delete_preset
Full name: directus.directus_delete_preset

Parameter	Type	Required	Description
No parameters.

list_collections Read

Returns a list of the collections available in the project.

Lua path: app.integrations.directus.list_collections
Full name: directus.directus_list_collections

Parameter	Type	Required	Description
No parameters.

create_collection Write

Create a new collection in Directus.

Lua path: app.integrations.directus.create_collection
Full name: directus.directus_create_collection

Parameter	Type	Required	Description
No parameters.

retrieve_collection Read

Retrieves the details of a single collection.

Lua path: app.integrations.directus.retrieve_collection
Full name: directus.directus_get_collection

Parameter	Type	Required	Description
No parameters.

update_collection Write

Update an existing collection.

Lua path: app.integrations.directus.update_collection
Full name: directus.directus_update_collection

Parameter	Type	Required	Description
No parameters.

delete_collection Write

Delete an existing collection. Warning: This will delete the whole collection, including the items within. Proceed with caution.

Lua path: app.integrations.directus.delete_collection
Full name: directus.directus_delete_collection

Parameter	Type	Required	Description
No parameters.

list_comments Read

List the comments.

Lua path: app.integrations.directus.list_comments
Full name: directus.directus_get_comments

Parameter	Type	Required	Description
No parameters.

create_comment Write

Create a new comment.

Lua path: app.integrations.directus.create_comment
Full name: directus.directus_create_comment

Parameter	Type	Required	Description
No parameters.

update_multiple_comments Write

Update multiple comments at the same time.

Lua path: app.integrations.directus.update_multiple_comments
Full name: directus.directus_update_comments

Parameter	Type	Required	Description
No parameters.

delete_multiple_comments Write

Delete multiple existing comments.

Lua path: app.integrations.directus.delete_multiple_comments
Full name: directus.directus_delete_comments

Parameter	Type	Required	Description
No parameters.

retrieve_comment Read

Retrieve a single comment by unique identifier.

Lua path: app.integrations.directus.retrieve_comment
Full name: directus.directus_get_comment

Parameter	Type	Required	Description
No parameters.

update_comment Write

Update an existing comment.

Lua path: app.integrations.directus.update_comment
Full name: directus.directus_update_comment

Parameter	Type	Required	Description
No parameters.

delete_comment Write

Delete an existing comment.

Lua path: app.integrations.directus.delete_comment
Full name: directus.directus_delete_comment

Parameter	Type	Required	Description
No parameters.

list_extensions Read

List the installed extensions and their configuration in the project.

Lua path: app.integrations.directus.list_extensions
Full name: directus.directus_list_extensions

Parameter	Type	Required	Description
No parameters.

update_extension Write

Update an existing extension.

Lua path: app.integrations.directus.update_extension
Full name: directus.directus_update_extensions

Parameter	Type	Required	Description
No parameters.

update_extension Write

Update an existing extension.

Lua path: app.integrations.directus.update_extension
Full name: directus.directus_update_extension_bundle

Parameter	Type	Required	Description
No parameters.

list_all_fields Read

Returns a list of the fields available in the project.

Lua path: app.integrations.directus.list_all_fields
Full name: directus.directus_get_fields

Parameter	Type	Required	Description
No parameters.

list_fields_collection Read

Returns a list of the fields available in the given collection.

Lua path: app.integrations.directus.list_fields_collection
Full name: directus.directus_get_collection_fields

Parameter	Type	Required	Description
No parameters.

create_field_collection Write

Create a new field in a given collection.

Lua path: app.integrations.directus.create_field_collection
Full name: directus.directus_create_field

Parameter	Type	Required	Description
No parameters.

retrieve_field Read

Retrieves the details of a single field in a given collection.

Lua path: app.integrations.directus.retrieve_field
Full name: directus.directus_get_collection_field

Parameter	Type	Required	Description
No parameters.

update_field Write

Update an existing field.

Lua path: app.integrations.directus.update_field
Full name: directus.directus_update_field

Parameter	Type	Required	Description
No parameters.

delete_field Write

Delete an existing field.

Lua path: app.integrations.directus.delete_field
Full name: directus.directus_delete_field

Parameter	Type	Required	Description
No parameters.

list_files Read

List the files.

Lua path: app.integrations.directus.list_files
Full name: directus.directus_get_files

Parameter	Type	Required	Description
No parameters.

create_file Write

Create a new file

Lua path: app.integrations.directus.create_file
Full name: directus.directus_create_file

Parameter	Type	Required	Description
No parameters.

update_multiple_files Write

Update multiple files at the same time.

Lua path: app.integrations.directus.update_multiple_files
Full name: directus.directus_update_files

Parameter	Type	Required	Description
No parameters.

delete_multiple_files Write

Delete multiple existing files.

Lua path: app.integrations.directus.delete_multiple_files
Full name: directus.directus_delete_files

Parameter	Type	Required	Description
No parameters.

retrieve_files Read

Retrieve a single file by unique identifier.

Lua path: app.integrations.directus.retrieve_files
Full name: directus.directus_get_file

Parameter	Type	Required	Description
No parameters.

update_file Write

Update an existing file, and/or replace it's file contents.

Lua path: app.integrations.directus.update_file
Full name: directus.directus_update_file

Parameter	Type	Required	Description
No parameters.

delete_file Write

Delete an existing file.

Lua path: app.integrations.directus.delete_file
Full name: directus.directus_delete_file

Parameter	Type	Required	Description
No parameters.

list_flows Read

Get all flows.

Lua path: app.integrations.directus.list_flows
Full name: directus.directus_get_flows

Parameter	Type	Required	Description
No parameters.

create_flow Write

Create a new flow.

Lua path: app.integrations.directus.create_flow
Full name: directus.directus_create_flow

Parameter	Type	Required	Description
No parameters.

update_multiple_flows Write

Update multiple flows at the same time.

Lua path: app.integrations.directus.update_multiple_flows
Full name: directus.directus_update_flows

Parameter	Type	Required	Description
No parameters.

delete_multiple_flows Write

Delete multiple existing flows.

Lua path: app.integrations.directus.delete_multiple_flows
Full name: directus.directus_delete_flows

Parameter	Type	Required	Description
No parameters.

retrieve_flow Read

Retrieve a single flow by unique identifier.

Lua path: app.integrations.directus.retrieve_flow
Full name: directus.directus_get_flow

Parameter	Type	Required	Description
No parameters.

update_flow Write

Update an existing flow

Lua path: app.integrations.directus.update_flow
Full name: directus.directus_update_flow

Parameter	Type	Required	Description
No parameters.

delete_flow Write

Delete an existing flow

Lua path: app.integrations.directus.delete_flow
Full name: directus.directus_delete_flow

Parameter	Type	Required	Description
No parameters.

list_folders Read

List the folders.

Lua path: app.integrations.directus.list_folders
Full name: directus.directus_get_folders

Parameter	Type	Required	Description
No parameters.

create_folder Write

Create a new folder.

Lua path: app.integrations.directus.create_folder
Full name: directus.directus_create_folder

Parameter	Type	Required	Description
No parameters.

update_multiple_folders Write

Update multiple folders at the same time.

Lua path: app.integrations.directus.update_multiple_folders
Full name: directus.directus_update_folders

Parameter	Type	Required	Description
No parameters.

delete_multiple_folders Write

Delete multiple existing folders.

Lua path: app.integrations.directus.delete_multiple_folders
Full name: directus.directus_delete_folders

Parameter	Type	Required	Description
No parameters.

retrieve_folder Read

Retrieve a single folder by unique identifier.

Lua path: app.integrations.directus.retrieve_folder
Full name: directus.directus_get_folder

Parameter	Type	Required	Description
No parameters.

update_folder Write

Update an existing folder

Lua path: app.integrations.directus.update_folder
Full name: directus.directus_update_folder

Parameter	Type	Required	Description
No parameters.

delete_folder Write

Delete an existing folder

Lua path: app.integrations.directus.delete_folder
Full name: directus.directus_delete_folder

Parameter	Type	Required	Description
No parameters.

list_operations Read

Get all operations.

Lua path: app.integrations.directus.list_operations
Full name: directus.directus_get_operations

Parameter	Type	Required	Description
No parameters.

create_operation Write

Create a new operation.

Lua path: app.integrations.directus.create_operation
Full name: directus.directus_create_operation

Parameter	Type	Required	Description
No parameters.

update_multiple_operations Write

Update multiple operations at the same time.

Lua path: app.integrations.directus.update_multiple_operations
Full name: directus.directus_update_operations

Parameter	Type	Required	Description
No parameters.

delete_multiple_operations Write

Delete multiple existing operations.

Lua path: app.integrations.directus.delete_multiple_operations
Full name: directus.directus_delete_operations

Parameter	Type	Required	Description
No parameters.

retrieve_operation Read

Retrieve a single operation by unique identifier.

Lua path: app.integrations.directus.retrieve_operation
Full name: directus.directus_get_operation

Parameter	Type	Required	Description
No parameters.

update_operation Write

Update an existing operation

Lua path: app.integrations.directus.update_operation
Full name: directus.directus_update_operation

Parameter	Type	Required	Description
No parameters.

delete_operation Write

Delete an existing operation

Lua path: app.integrations.directus.delete_operation
Full name: directus.directus_delete_operation

Parameter	Type	Required	Description
No parameters.

list_permissions Read

List all permissions.

Lua path: app.integrations.directus.list_permissions
Full name: directus.directus_get_permissions

Parameter	Type	Required	Description
No parameters.

create_permission Write

Create a new permission.

Lua path: app.integrations.directus.create_permission
Full name: directus.directus_create_permission

Parameter	Type	Required	Description
No parameters.

update_multiple_permissions Write

Update multiple permissions at the same time.

Lua path: app.integrations.directus.update_multiple_permissions
Full name: directus.directus_update_permissions

Parameter	Type	Required	Description
No parameters.

delete_multiple_permissions Write

Delete multiple existing permissions.

Lua path: app.integrations.directus.delete_multiple_permissions
Full name: directus.directus_delete_permissions

Parameter	Type	Required	Description
No parameters.

list_my_permissions Read

List the permissions that apply to the current user.

Lua path: app.integrations.directus.list_my_permissions
Full name: directus.directus_get_my_permissions

Parameter	Type	Required	Description
No parameters.

retrieve_permission Read

Retrieve a single permissions object by unique identifier.

Lua path: app.integrations.directus.retrieve_permission
Full name: directus.directus_get_permission

Parameter	Type	Required	Description
No parameters.

update_permission Write

Update an existing permission

Lua path: app.integrations.directus.update_permission
Full name: directus.directus_update_permission

Parameter	Type	Required	Description
No parameters.

delete_permission Write

Delete an existing permission

Lua path: app.integrations.directus.delete_permission
Full name: directus.directus_delete_permission

Parameter	Type	Required	Description
No parameters.

list_relations Read

List the relations.

Lua path: app.integrations.directus.list_relations
Full name: directus.directus_get_relations

Parameter	Type	Required	Description
No parameters.

create_relation Write

Create a new relation.

Lua path: app.integrations.directus.create_relation
Full name: directus.directus_create_relation

Parameter	Type	Required	Description
No parameters.

retrieve_relation Read

Retrieve a single relation by unique identifier.

Lua path: app.integrations.directus.retrieve_relation
Full name: directus.directus_get_relation

Parameter	Type	Required	Description
No parameters.

update_relation Write

Update an existing relation

Lua path: app.integrations.directus.update_relation
Full name: directus.directus_update_relation

Parameter	Type	Required	Description
No parameters.

delete_relation Write

Delete an existing relation.

Lua path: app.integrations.directus.delete_relation
Full name: directus.directus_delete_relation

Parameter	Type	Required	Description
No parameters.

list_revisions Read

List the revisions.

Lua path: app.integrations.directus.list_revisions
Full name: directus.directus_get_revisions

Parameter	Type	Required	Description
No parameters.

retrieve_revision Read

Retrieve a single revision by unique identifier.

Lua path: app.integrations.directus.retrieve_revision
Full name: directus.directus_get_revision

Parameter	Type	Required	Description
No parameters.

list_roles Read

List the roles.

Lua path: app.integrations.directus.list_roles
Full name: directus.directus_get_roles

Parameter	Type	Required	Description
No parameters.

create_role Write

Create a new role.

Lua path: app.integrations.directus.create_role
Full name: directus.directus_create_role

Parameter	Type	Required	Description
No parameters.

update_multiple_roles Write

Update multiple roles at the same time.

Lua path: app.integrations.directus.update_multiple_roles
Full name: directus.directus_update_roles

Parameter	Type	Required	Description
No parameters.

delete_multiple_roles Write

Delete multiple existing roles.

Lua path: app.integrations.directus.delete_multiple_roles
Full name: directus.directus_delete_roles

Parameter	Type	Required	Description
No parameters.

retrieve_role Read

Retrieve a single role by unique identifier.

Lua path: app.integrations.directus.retrieve_role
Full name: directus.directus_get_role

Parameter	Type	Required	Description
No parameters.

update_role Write

Update an existing role

Lua path: app.integrations.directus.update_role
Full name: directus.directus_update_role

Parameter	Type	Required	Description
No parameters.

delete_role Write

Delete an existing role

Lua path: app.integrations.directus.delete_role
Full name: directus.directus_delete_role

Parameter	Type	Required	Description
No parameters.

retrieve_schema_snapshot Read

Retrieve the current schema. This endpoint is only available to admin users.

Lua path: app.integrations.directus.retrieve_schema_snapshot
Full name: directus.directus_schema_snapshot

Parameter	Type	Required	Description
No parameters.

apply_schema_difference Write

Update the instance's schema by passing the diff previously retrieved via /schema/diff endpoint in the JSON request body or a JSON/YAML file. This endpoint is only available to admin users.

Lua path: app.integrations.directus.apply_schema_difference
Full name: directus.directus_schema_apply

Parameter	Type	Required	Description
No parameters.

retrieve_schema_difference Write

Compare the current instance's schema against the schema snapshot in JSON request body or a JSON/YAML file and retrieve the difference. This endpoint is only available to admin users.

Lua path: app.integrations.directus.retrieve_schema_difference
Full name: directus.directus_schema_diff

Parameter	Type	Required	Description
No parameters.

system_info Read

Perform a system status check and return the options.

Lua path: app.integrations.directus.system_info
Full name: directus.directus_server_info

Parameter	Type	Required	Description
No parameters.

ping Read

Ping, pong. Ping.. pong.

Lua path: app.integrations.directus.ping
Full name: directus.directus_ping

Parameter	Type	Required	Description
No parameters.

retrieve_settings Read

List the settings.

Lua path: app.integrations.directus.retrieve_settings
Full name: directus.directus_get_settings

Parameter	Type	Required	Description
No parameters.

update_settings Write

Update the settings

Lua path: app.integrations.directus.update_settings
Full name: directus.directus_update_setting

Parameter	Type	Required	Description
No parameters.

list_users Read

List the users.

Lua path: app.integrations.directus.list_users
Full name: directus.directus_get_users

Parameter	Type	Required	Description
No parameters.

create_user Write

Create a new user.

Lua path: app.integrations.directus.create_user
Full name: directus.directus_create_user

Parameter	Type	Required	Description
No parameters.

update_multiple_users Write

Update multiple users at the same time.

Lua path: app.integrations.directus.update_multiple_users
Full name: directus.directus_update_users

Parameter	Type	Required	Description
No parameters.

delete_multiple_users Write

Delete multiple existing users.

Lua path: app.integrations.directus.delete_multiple_users
Full name: directus.directus_delete_users

Parameter	Type	Required	Description
No parameters.

retrieve_user Read

Retrieve a single user by unique identifier.

Lua path: app.integrations.directus.retrieve_user
Full name: directus.directus_get_user

Parameter	Type	Required	Description
No parameters.

update_user Write

Update an existing user

Lua path: app.integrations.directus.update_user
Full name: directus.directus_update_user

Parameter	Type	Required	Description
No parameters.

delete_user Write

Delete an existing user

Lua path: app.integrations.directus.delete_user
Full name: directus.directus_delete_user

Parameter	Type	Required	Description
No parameters.

invite_users Write

Invites one or more users to this project. It creates a user with an invited status, and then sends an email to the user with instructions on how to activate their account.

Lua path: app.integrations.directus.invite_users
Full name: directus.directus_invite

Parameter	Type	Required	Description
No parameters.

accept_user_invite Write

Accepts and enables an invited user using a JWT invitation token.

Lua path: app.integrations.directus.accept_user_invite
Full name: directus.directus_accept_invite

Parameter	Type	Required	Description
No parameters.

retrieve_current_user Read

Retrieve the currently authenticated user.

Lua path: app.integrations.directus.retrieve_current_user
Full name: directus.directus_get_current_user

Parameter	Type	Required	Description
No parameters.

update_current_user Write

Update the currently authenticated user.

Lua path: app.integrations.directus.update_current_user
Full name: directus.directus_update_me

Parameter	Type	Required	Description
No parameters.

update_last_page Write

Updates the last used page field of the currently authenticated user. This is used internally to be able to open the Directus admin app from the last page you used.

Lua path: app.integrations.directus.update_last_page
Full name: directus.directus_update_last_used_page_me

Parameter	Type	Required	Description
No parameters.

enable_2fa Write

Enables two-factor authentication for the currently authenticated user.

Lua path: app.integrations.directus.enable_2fa
Full name: directus.directus_me_tfa_enable

Parameter	Type	Required	Description
No parameters.

disable_2fa Write

Disables two-factor authentication for the currently authenticated user.

Lua path: app.integrations.directus.disable_2fa
Full name: directus.directus_me_tfa_disable

Parameter	Type	Required	Description
No parameters.

hash_string Write

Generate a hash for a given string.

Lua path: app.integrations.directus.hash_string
Full name: directus.directus_hash_generate

Parameter	Type	Required	Description
No parameters.

hash_string Write

Generate a hash for a given string.

Lua path: app.integrations.directus.hash_string
Full name: directus.directus_hash_verify

Parameter	Type	Required	Description
No parameters.

sort_items Write

Re-sort items in collection based on start and to value of item

Lua path: app.integrations.directus.sort_items
Full name: directus.directus_sort

Parameter	Type	Required	Description
No parameters.

import_items Write

Import multiple records from a JSON or CSV file into a collection.

Lua path: app.integrations.directus.import_items
Full name: directus.directus_import

Parameter	Type	Required	Description
No parameters.

export_items Write

Export a larger data set to a file in the File Library

Lua path: app.integrations.directus.export_items
Full name: directus.directus_export

Parameter	Type	Required	Description
No parameters.

clear_cache Write

Resets both the data and schema cache of Directus.

Lua path: app.integrations.directus.clear_cache
Full name: directus.directus_clear_cache

Parameter	Type	Required	Description
No parameters.

get_random_string Read

Returns a random string of given length.

Lua path: app.integrations.directus.get_random_string
Full name: directus.directus_random

Parameter	Type	Required	Description
No parameters.

list_content_versions Read

Get all Content Versions.

Lua path: app.integrations.directus.list_content_versions
Full name: directus.directus_get_content_versions

Parameter	Type	Required	Description
No parameters.

create_multiple_content_versions Write

Create multiple new Content Versions.

Lua path: app.integrations.directus.create_multiple_content_versions
Full name: directus.directus_create_content_version

Parameter	Type	Required	Description
No parameters.

update_multiple_content_versions Write

Update multiple Content Versions at the same time.

Lua path: app.integrations.directus.update_multiple_content_versions
Full name: directus.directus_update_content_versions

Parameter	Type	Required	Description
No parameters.

delete_multiple_content_versions Write

Delete multiple existing Content Versions.

Lua path: app.integrations.directus.delete_multiple_content_versions
Full name: directus.directus_delete_content_versions

Parameter	Type	Required	Description
No parameters.

retrieve_content_version Read

Retrieve a single Content Version by unique identifier.

Lua path: app.integrations.directus.retrieve_content_version
Full name: directus.directus_get_content_version

Parameter	Type	Required	Description
No parameters.

update_content_version Write

Update an existing Content Version.

Lua path: app.integrations.directus.update_content_version
Full name: directus.directus_update_content_version

Parameter	Type	Required	Description
No parameters.

delete_content_version Write

Delete an existing Content Version.

Lua path: app.integrations.directus.delete_content_version
Full name: directus.directus_delete_content_version

Parameter	Type	Required	Description
No parameters.

save_content_version Write

Save item changes to an existing Content Version.

Lua path: app.integrations.directus.save_content_version
Full name: directus.directus_save_content_version

Parameter	Type	Required	Description
No parameters.

compare_content_version Read

Compare an existing Content Version with the main version of the item.

Lua path: app.integrations.directus.compare_content_version
Full name: directus.directus_compare_content_version

Parameter	Type	Required	Description
No parameters.

promote_content_version Write

Pass the current hash of the main version of the item obtained from the compare endpoint along with an optional array of field names of which the values are to be promoted by default, all fields are selected.

Lua path: app.integrations.directus.promote_content_version
Full name: directus.directus_promote_content_version

Parameter	Type	Required	Description
No parameters.