Cfengine

Cfengine Hosts API

The Hosts API from Cfengine — 6 operation(s) for hosts.

Documentation GitHub OpenAPI

Operations 6

DELETE /api/hosts/delete-permanently/SHA Host REST API #

DELETE /api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d DELETE /api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda124… #

POST /api/hosts/restore-deleted/SHA Host REST API #

POST /api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d POST /api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94e… #

GET /api/hosts/{hostid} GET /api/hosts/{hostid} #

GET /api/hosts/{hostid}/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d Host REST API #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/cfengine/openapi/cfengine-hosts-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-delete-api-build-projects1-modules-autorun-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-get-api-build-buildid-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-patch-api-build-projects1-modules-autorun-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-post-api-build-projects1-modules-autorun-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-get-api-build-modules-autorun100-response-schema.json

📊

JSONSchema

https://artifacts.apis.io/cfengine/json-schema/cfengine-get-api-build-modules-autorun-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/cfengine:cfengine-hosts-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Cfengine Hosts API
  version: '2026-10-08'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-08: 44 operation(s) read from 8 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Cfengine has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 42
    documentation: 2
    pages-with-code: 8
    pages-read: 8
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-08'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ai-chat
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/cmdb-api
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/web-rbac
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/build-api
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/inventory
  - https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/users-rbac
servers:
- url: https://hub.cfengine.com
security:
- api_token: []
- Basic: []
- Bearer: []
tags:
- name: Hosts
paths:
  /api/hosts/delete-permanently/SHA:
    delete:
      operationId: delete_api_hosts_delete_permanently_SHA
      tags:
      - Hosts
      summary: Host REST API
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d:
    delete:
      operationId: delete_api_hosts_delete_permanently_SHA_2123f85b38189008ae12be159fb961584dda1249
      tags:
      - Hosts
      summary: DELETE /api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda124…
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteApiHostsDeletePermanentlySha2123F85B38189008Ae12Be159F'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -k --user <username>:<password> -X DELETE https://hub.example.com/api/hosts/delete-permanently/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d \n Example response: \n HTTP 200 Ok \n List monitoring attributes for host \n URI: https://hub.cfengine.com/api/host/:host-id/vital \n Method: GET \n List all available vital attributes monitored by CFEngine on the client. \n Note: Collec"
  /api/hosts/restore-deleted/SHA:
    post:
      operationId: post_api_hosts_restore_deleted_SHA
      tags:
      - Hosts
      summary: Host REST API
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d:
    post:
      operationId: post_api_hosts_restore_deleted_SHA_2123f85b38189008ae12be159fb961584dda1249c94ef
      tags:
      - Hosts
      summary: POST /api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94e…
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiHostsRestoreDeletedSha2123F85B38189008Ae12Be159Fb9615'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -k --user <username>:<password> -X POST https://hub.example.com/api/hosts/restore-deleted/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d \n Example response: \n HTTP 200 Ok \n Permanently delete host entry \n URI: https://hub.cfengine.com/api/hosts/delete-permanently/:host-id \n Method: DELETE \n Permanently deletes deleted host entry from the reporting database. \n Notes: \n To"
  /api/hosts/{hostid}:
    get:
      operationId: get_api_hosts_hostid
      tags:
      - Hosts
      summary: GET /api/hosts/{hostid}
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      parameters:
      - name: hostid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiHostsHostidResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -k --user admin:admin -X GET https://hub.example.com/api/hosts/by-class \n Example response: \n {\n \"10_0_2_15\": {\n \"hosts\": [\n \"ubuntu-xenial\"\n ]\n },\n \"127_0_0_1\": {\n \"hosts\": [\n \"ubuntu-xenial\"\n ]\n },\n \"ubuntu_16\": {\n \"hosts\": [\n \"ubuntu-xenial\"\n ]\n }\n} \n inventoryFile=true "
        collapsed_from: 2 example path(s) differing only at hostId
  /api/hosts/{hostid}/SHA=2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c70f233975d:
    get:
      operationId: get_api_hosts_hostid_SHA_2123f85b38189008ae12be159fb961584dda1249c94efed43fec2c7
      tags:
      - Hosts
      summary: Host REST API
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/host
      parameters:
      - name: hostid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at hostId
components:
  schemas:
    GetApiHostsHostidResponse:
      type: object
      properties:
        '10_0_2_15':
          type: object
          properties:
            hosts:
              type: array
              items:
                type: string
        '127_0_0_1':
          type: object
          properties:
            hosts:
              type: array
              items:
                type: string
        ubuntu_16:
          type: object
          properties:
            hosts:
              type: array
              items:
                type: string
    PostApiHostsRestoreDeletedSha2123F85B38189008Ae12Be159Fb9615:
      type: object
      properties:
        meta:
          type: object
          properties:
            page:
              type: integer
            count:
              type: integer
            total:
              type: integer
            timestamp:
              type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              timestamp:
                type: integer
              description:
                type: string
              units:
                type: string
    DeleteApiHostsDeletePermanentlySha2123F85B38189008Ae12Be159F:
      type: object
      properties:
        meta:
          type: object
          properties:
            page:
              type: integer
            count:
              type: integer
            total:
              type: integer
            timestamp:
              type: integer
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              timestamp:
                type: integer
              description:
                type: string
              units:
                type: string
  securitySchemes:
    api_token:
      type: apiKey
      in: header
      name: Authorization
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/
    Basic:
      type: http
      scheme: basic
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/
    Bearer:
      type: http
      scheme: bearer
      x-source: https://docs.cfengine.com/docs/lts/api/enterprise-api-ref/ldap-api/