# Cfengine API

**Canonical:** https://apis.io/apis/cfengine/cfengine-api/  
**Provider:** Cfengine — https://apis.io/providers/cfengine/  
**Base URL:** https://hub.cfengine.com  
**Documentation:** https://docs.cfengine.com/docs/lts/api/enterprise-api-ref

Cfengine API is one of 2 APIs that [Cfengine](https://apis.io/providers/cfengine/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Cfengine API as documented publicly: 44 operations. Contract generated from the documentation by API Evangelist (2026-10-08); not the provider's own document.

## Operations (44)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/ai/text-to-sql` | POST /api/ai/text-to-sql |
| GET | `/api/build/modules/autorun` | GET /api/build/modules/autorun |
| GET | `/api/build/modules/autorun/1.0.0` | GET /api/build/modules/autorun/1.0.0 |
| DELETE | `/api/build/projects/1/modules/autorun` | DELETE /api/build/projects/1/modules/autorun |
| PATCH | `/api/build/projects/1/modules/autorun` | PATCH /api/build/projects/1/modules/autorun |
| POST | `/api/build/projects/1/modules/autorun` | POST /api/build/projects/1/modules/autorun |
| GET | `/api/build/projects/1/modules/delete-files/input` | GET /api/build/projects/1/modules/delete-files/input |
| POST | `/api/build/projects/1/modules/delete-files/input` | POST /api/build/projects/1/modules/delete-files/input |
| DELETE | `/api/build/projects/2` | DELETE /api/build/projects/2 |
| GET | `/api/build/projects/2` | GET /api/build/projects/2 |
| PATCH | `/api/build/projects/2` | PATCH /api/build/projects/2 |
| POST | `/api/build/projects/2/refresh` | POST /api/build/projects/2/refresh |
| GET | `/api/build/projects/5/modules` | GET /api/build/projects/5/modules |
| POST | `/api/build/projects/{projectid}` | POST /api/build/projects/2 |
| GET | `/api/build/{buildid}` | GET /api/build/{buildid} |
| POST | `/api/build/{buildid}` | POST /api/build/{buildid} |
| GET | `/api/cmdb/v2/{hostkey}` | Get all configuration entries for a specific host. |
| POST | `/api/cmdb/v2/{hostkey}` | Create a new configuration entry for a host. |
| GET | `/api/cmdb/v2/{hostkey}/{hostkeyid}` | Get the rendered JSON configuration file for a host. |
| GET | `/api/cmdb/v2/subentry/{hostkey}/{type}/{name}` | Get a specific sub-entry by type and name. |
| DELETE | `/api/hosts/delete-permanently/SHA` | Host REST API |
| DELETE | `/api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d` | DELETE /api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d |
| POST | `/api/hosts/restore-deleted/SHA` | Host REST API |
| POST | `/api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d` | POST /api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d |
| GET | `/api/hosts/{hostid}` | GET /api/hosts/{hostid} |
| GET | `/api/hosts/{hostid}/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d` | Host REST API |
| GET | `/api/inventory/attributes-dictionary` | GET /api/inventory/attributes-dictionary |
| PATCH | `/api/inventory/attributes-dictionary/{attributesdictionaryid}` | PATCH /api/inventory/attributes-dictionary/{attributesDictionaryId} |
| GET | `/api/rbac/user-permissions` | GET /api/rbac/user-permissions |
| DELETE | `/api/role/{roleId}` | Remove role definition. |
| GET | `/api/role/{roleId}` | Get role definition. |
| POST | `/api/role/{roleId}` | Update role definition. |
| PUT | `/api/role/{roleId}` | Create a new role definition. |
| DELETE | `/api/role/{roleName}/permissions` | Revoke permissions from role |
| GET | `/api/role/{roleName}/permissions` | Get role permissions |
| POST | `/api/role/{roleName}/permissions` | Add permissions to role |
| PUT | `/api/role/{roleName}/permissions` | Rewrite role’s permissions |
| DELETE | `/api/user/{username}` | Remove internal user. |
| GET | `/api/user/{username}` | Get info for a specified user. |
| POST | `/api/user/{username}` | Update user information. |
| PUT | `/api/user/{username}` | Create a new user. |
| POST | `/api/user/{username}/unlock` | Unlock a user locked out due to two‑factor authentication setup. |
| GET | `/api/{apiid}` | GET /api/rbac |
| POST | `/api/{apiid}` | POST /api/host-count |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/openapi/_ae-authored/cfengine-openapi-generated.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-delete-api-build-projects1-modules-autorun-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-get-api-build-buildid-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-patch-api-build-projects1-modules-autorun-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-post-api-build-projects1-modules-autorun-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-get-api-build-modules-autorun100-response-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/cfengine/refs/heads/main/json-schema/cfengine-get-api-build-modules-autorun-response-schema.json

## Other Cfengine APIs (1)

- [Cfengine API](https://apis.io/apis/cfengine/cfengine-api-2/)

---

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