ArangoDB v3.8 reached End of Life (EOL) and is no longer supported.
This documentation is outdated. Please see the most recent version at docs.arangodb.com
Foxx Service configuration / dependencies
This is an introduction to ArangoDB’s HTTP interface for managing Foxx services configuration and dependencies.
Get configuration options
get configuration options
GET /_api/foxx/configuration
Query Parameters
- mount (string, required): Mount path of the installed service.
Fetches the current configuration for the service at the given mount path.
Returns an object mapping the configuration option names to their definitions including a human-friendly title and the current value (if any).
Responses
HTTP 200: Returned if the request was successful.
Update configuration options
update configuration options
PATCH /_api/foxx/configuration
Query Parameters
- mount (string, required): Mount path of the installed service.
Request Body
(json, required)
A JSON object mapping configuration option names to their new values. Any omitted options will be ignored.
Replaces the given service’s configuration.
Returns an object mapping all configuration option names to their new values.
Responses
HTTP 200: Returned if the request was successful.
Replace configuration options
replace configuration options
PUT /_api/foxx/configuration
Query Parameters
- mount (string, required): Mount path of the installed service.
Request Body
(json, required)
A JSON object mapping configuration option names to their new values. Any omitted options will be reset to their default values or marked as unconfigured.
Replaces the given service’s configuration completely.
Returns an object mapping all configuration option names to their new values.
Responses
HTTP 200: Returned if the request was successful.
Get dependency options
get dependency options
GET /_api/foxx/dependencies
Query Parameters
- mount (string, required): Mount path of the installed service.
Fetches the current dependencies for service at the given mount path.
Returns an object mapping the dependency names to their definitions including a human-friendly title and the current mount path (if any).
Responses
HTTP 200: Returned if the request was successful.
Update dependencies options
update dependencies options
PATCH /_api/foxx/dependencies
Query Parameters
- mount (string, required): Mount path of the installed service.
Request Body
(json, required)
A JSON object mapping dependency names to their new mount paths. Any omitted dependencies will be ignored.
Replaces the given service’s dependencies.
Returns an object mapping all dependency names to their new mount paths.
Responses
HTTP 200: Returned if the request was successful.
Replace dependencies options
replace dependencies options
PUT /_api/foxx/dependencies
Query Parameters
- mount (string, required): Mount path of the installed service.
Request Body
(json, required)
A JSON object mapping dependency names to their new mount paths. Any omitted dependencies will be disabled.
Replaces the given service’s dependencies completely.
Returns an object mapping all dependency names to their new mount paths.
Responses
HTTP 200: Returned if the request was successful.