# DreamFactory System API

**Canonical:** https://apis.io/apis/dreamfactory/system-api/  
**Provider:** DreamFactory — https://apis.io/providers/dreamfactory/  
**Base URL:** https://{instance}/api/v2/system  
**Documentation:** https://guide.dreamfactory.com/docs/using-the-system-apis/

DreamFactory System API is one of 16 APIs that [DreamFactory](https://apis.io/providers/dreamfactory/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 5 JSON Schema definitions. Tagged areas include Administration, Automation, Deployment, Documentation, and Generation. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, an AsyncAPI specification, a JSON-LD context, and 5 JSON Schemas.

The DreamFactory System API provides administrative management capabilities for DreamFactory instances. It allows managing services, apps, roles, users, CORS configurations, email templates, environment settings, lookups, rate limits, events, scripts, and more via REST endpoints under /api/v2/system/.

## Machine-readable artifacts (10)

- **Documentation** — https://guide.dreamfactory.com/docs/using-the-system-apis/
- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/openapi/dreamfactory-system-api-openapi.yml
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/asyncapi/dreamfactory-system-api-asyncapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-schema/dreamfactory-admin.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-schema/dreamfactory-app.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-schema/dreamfactory-role.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-schema/dreamfactory-service.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-schema/dreamfactory-user.json
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/json-ld/dreamfactory-context.jsonld
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/dreamfactory/refs/heads/main/apis.yml

## Other DreamFactory APIs (12)

- [DreamFactory Admin API](https://apis.io/apis/dreamfactory/dreamfactory-admin-api/)
- [DreamFactory App API](https://apis.io/apis/dreamfactory/dreamfactory-app-api/)
- [DreamFactory AppGroup API](https://apis.io/apis/dreamfactory/dreamfactory-appgroup-api/)
- [DreamFactory CORS API](https://apis.io/apis/dreamfactory/dreamfactory-cors-api/)
- [DreamFactory Custom API](https://apis.io/apis/dreamfactory/dreamfactory-custom-api/)
- [DreamFactory EmailTemplate API](https://apis.io/apis/dreamfactory/dreamfactory-emailtemplate-api/)
- [DreamFactory Environment API](https://apis.io/apis/dreamfactory/dreamfactory-environment-api/)
- [DreamFactory Event API](https://apis.io/apis/dreamfactory/dreamfactory-event-api/)
- [DreamFactory Limit API](https://apis.io/apis/dreamfactory/dreamfactory-limit-api/)
- [DreamFactory Lookup API](https://apis.io/apis/dreamfactory/dreamfactory-lookup-api/)
- [DreamFactory Package API](https://apis.io/apis/dreamfactory/dreamfactory-package-api/)
- [DreamFactory Role API](https://apis.io/apis/dreamfactory/dreamfactory-role-api/)

## Tags

Administration, Automation, Deployment, Documentation, Generation, Security

---

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