# ArangoDB Foxx API

**Canonical:** https://apis.io/apis/arangodb/arangodb-foxx-api/  
**Provider:** ArangoDB — https://apis.io/providers/arangodb/  
**Base URL:** https://{deployment-id}.arangodb.cloud:8529  
**Documentation:** https://docs.arango.ai/arangodb/stable/develop/http-api/

ArangoDB Foxx API is one of 24 APIs that [ArangoDB](https://apis.io/providers/arangodb/) publishes on the [APIs.io](https://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.

Manage microservices written in JavaScript

## Operations (21)

| Method | Path | Summary |
|---|---|---|
| GET | `/_db/{database-name}/_api/foxx` | List the installed services |
| POST | `/_db/{database-name}/_api/foxx` | Install a new service |
| POST | `/_db/{database-name}/_api/foxx/commit` | Commit the local service state |
| GET | `/_db/{database-name}/_api/foxx/configuration` | Get the configuration options |
| PATCH | `/_db/{database-name}/_api/foxx/configuration` | Update the configuration options |
| PUT | `/_db/{database-name}/_api/foxx/configuration` | Replace the configuration options |
| GET | `/_db/{database-name}/_api/foxx/dependencies` | Get the dependency options |
| PATCH | `/_db/{database-name}/_api/foxx/dependencies` | Update the dependency options |
| PUT | `/_db/{database-name}/_api/foxx/dependencies` | Replace the dependency options |
| DELETE | `/_db/{database-name}/_api/foxx/development` | Disable the development mode |
| POST | `/_db/{database-name}/_api/foxx/development` | Enable the development mode |
| POST | `/_db/{database-name}/_api/foxx/download` | Download a service bundle |
| GET | `/_db/{database-name}/_api/foxx/readme` | Get the service README |
| GET | `/_db/{database-name}/_api/foxx/scripts` | List the service scripts |
| POST | `/_db/{database-name}/_api/foxx/scripts/{name}` | Run a service script |
| DELETE | `/_db/{database-name}/_api/foxx/service` | Uninstall a service |
| GET | `/_db/{database-name}/_api/foxx/service` | Get the service description |
| PATCH | `/_db/{database-name}/_api/foxx/service` | Upgrade a service |
| PUT | `/_db/{database-name}/_api/foxx/service` | Replace a service |
| GET | `/_db/{database-name}/_api/foxx/swagger` | Get the Swagger description |
| POST | `/_db/{database-name}/_api/foxx/tests` | Run the service tests |

## Machine-readable artifacts (2)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/arangodb/refs/heads/main/openapi/arangodb-foxx-api-openapi.yml
- **Documentation** — https://docs.arango.ai/arangodb/stable/develop/http-api/

## Other ArangoDB APIs (12)

- [Arango Managed Platform (AMP) API](https://apis.io/apis/arangodb/amp-api/)
- [Arango Managed Platform SCIM API](https://apis.io/apis/arangodb/amp-scim-api/)
- [ArangoDB Administration API](https://apis.io/apis/arangodb/arangodb-administration-api/)
- [ArangoDB Analyzers API](https://apis.io/apis/arangodb/arangodb-analyzers-api/)
- [ArangoDB Authentication API](https://apis.io/apis/arangodb/arangodb-authentication-api/)
- [ArangoDB Batch Requests API](https://apis.io/apis/arangodb/arangodb-batch-requests-api/)
- [ArangoDB Cluster API](https://apis.io/apis/arangodb/arangodb-cluster-api/)
- [ArangoDB Collections API](https://apis.io/apis/arangodb/arangodb-collections-api/)
- [ArangoDB Databases API](https://apis.io/apis/arangodb/arangodb-databases-api/)
- [ArangoDB Documents API](https://apis.io/apis/arangodb/arangodb-documents-api/)
- [ArangoDB Graphs API](https://apis.io/apis/arangodb/arangodb-graphs-api/)
- [ArangoDB Hot Backups API](https://apis.io/apis/arangodb/arangodb-hot-backups-api/)

## Tags

Foxx

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/arangodb/arangodb-foxx-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/arangodb/.