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 (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).

Return codes

  • 200: Returned if the request was sucessful.

Update configuration options

update configuration options

PATCH /_api/foxx/configuration

Query Parameters

  • mount (required): Mount path of the installed service.

Request Body (json)

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.

Return codes

  • 200: Returned if the request was sucessful.

Replace configuration options

replace configuration options

PUT /_api/foxx/configuration

Query Parameters

  • mount (required): Mount path of the installed service.

Request Body (json)

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.

Return codes

  • 200: Returned if the request was sucessful.

Get dependency options

get dependency options

GET /_api/foxx/dependencies

Query Parameters

  • mount (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).

Return codes

  • 200: Returned if the request was sucessful.

Update dependencies options

update dependencies options

PATCH /_api/foxx/dependencies

Query Parameters

  • mount (required): Mount path of the installed service.

Request Body (json)

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.

Return codes

  • 200: Returned if the request was sucessful.

Replace dependencies options

replace dependencies options

PUT /_api/foxx/dependencies

Query Parameters

  • mount (required): Mount path of the installed service.

Request Body (json)

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.

Return codes

  • 200: Returned if the request was sucessful.