How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ArangoDB Foxx API

Manage microservices written in JavaScript

ArangoDB Foxx API is one of 24 APIs that ArangoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Foxx. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 21 operations across 12 paths. It is described by OpenAPI 3.2.0, at version 3.12.10 (API v0).

Requests are made against the base URL https://{deployment-id}.arangodb.cloud:8529.

21 operations 12 paths 0 schemas 2 DELETE7 GET3 PATCH6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.12.10 (API v0)
Base URL
https://{deployment-id}.arangodb.cloud:8529
Resource Areas
1

Paths & Operations 21

Across 12 paths, the API surfaces 21 operations — 2 DELETE, 7 GET, 3 PATCH, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Foxx 21

Manage microservices written in JavaScript

GET
/_db/{database-name}/_api/foxxdeprecated
List the installed services
listFoxxServices 2 params → 200
POST
/_db/{database-name}/_api/foxxdeprecated
Install a new service
createFoxxService 5 params → 201
POST
/_db/{database-name}/_api/foxx/commitdeprecated
Commit the local service state
commitFoxxServiceState 2 params → 204
GET
/_db/{database-name}/_api/foxx/configurationdeprecated
Get the configuration options
getFoxxConfiguration 2 params → 200
PATCH
/_db/{database-name}/_api/foxx/configurationdeprecated
Update the configuration options
updateFoxxConfiguration 2 params body → 200
PUT
/_db/{database-name}/_api/foxx/configurationdeprecated
Replace the configuration options
replaceFoxxConfiguration 2 params body → 200
GET
/_db/{database-name}/_api/foxx/dependenciesdeprecated
Get the dependency options
getFoxxDependencies 2 params → 200
PATCH
/_db/{database-name}/_api/foxx/dependenciesdeprecated
Update the dependency options
updateFoxxDependencies 2 params body → 200
PUT
/_db/{database-name}/_api/foxx/dependenciesdeprecated
Replace the dependency options
replaceFoxxDependencies 2 params body → 200
DELETE
/_db/{database-name}/_api/foxx/developmentdeprecated
Disable the development mode
disableFoxxDevelopmentMode 2 params → 200
POST
/_db/{database-name}/_api/foxx/developmentdeprecated
Enable the development mode
enableFoxxDevelopmentMode 2 params → 200
POST
/_db/{database-name}/_api/foxx/downloaddeprecated
Download a service bundle
downloadFoxxService 2 params → 200400
GET
/_db/{database-name}/_api/foxx/readmedeprecated
Get the service README
getFoxxReadme 2 params → 200204
GET
/_db/{database-name}/_api/foxx/scriptsdeprecated
List the service scripts
listFoxxScripts 2 params → 200
POST
/_db/{database-name}/_api/foxx/scripts/{name}deprecated
Run a service script
runFoxxScript 3 params body → 200
DELETE
/_db/{database-name}/_api/foxx/servicedeprecated
Uninstall a service
deleteFoxxService 3 params → 204
GET
/_db/{database-name}/_api/foxx/servicedeprecated
Get the service description
getFoxxServiceDescription 2 params → 200400
PATCH
/_db/{database-name}/_api/foxx/servicedeprecated
Upgrade a service
upgradeFoxxService 6 params → 200
PUT
/_db/{database-name}/_api/foxx/servicedeprecated
Replace a service
replaceFoxxService 6 params → 200
GET
/_db/{database-name}/_api/foxx/swaggerdeprecated
Get the Swagger description
getFoxxSwaggerDescription 2 params → 200
POST
/_db/{database-name}/_api/foxx/testsdeprecated
Run the service tests
runFoxxTests 5 params → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

arangodb-foxx-api-openapi.yml Raw ↑

Other APIs ArangoDB publishes across the network.

Arango Managed Platform (AMP) API
Arango Managed Platform SCIM API
ArangoDB Administration API
ArangoDB Analyzers API
ArangoDB Authentication API
ArangoDB Batch Requests API
ArangoDB Cluster API
ArangoDB Collections API
ArangoDB Databases API
ArangoDB Documents API
ArangoDB Graphs API
ArangoDB Hot Backups API
Where this information came from

This is an independent, third-party profile of ArangoDB Foxx API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.