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

farmOS Assets API

Physical or logical farm assets (land, animals, equipment, plants, etc.)

farmOS Assets API is one of 6 APIs that farmOS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Assets. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a GitHub repository.

This API exposes 35 operations across 14 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 2.x.

Requests are made against a single base URL, https://{farmOS-host}/api.

35 operations 14 paths 10 schemas 7 DELETE14 GET7 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.x
Base URL
https://{farmOS-host}/api
Authentication
OAuth 2.0, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

farmOS Assets API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2AuthorizationCode) using the authorizationCode flow, exposing 3 scopes. It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow, exposing 3 scopes. By default, every request must be authenticated.

  • oauth2AuthorizationCode — OAuth2 Authorization Code grant for third-party integrations. Users authorize the client application to access their farmOS data.
  • oauth2ClientCredentials — OAuth2 Client Credentials grant for machine-to-machine authentication. Used when no user account is required.

Paths & Operations 35

Across 14 paths, the API surfaces 35 operations — 7 DELETE, 14 GET, 7 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Assets 35

Physical or logical farm assets (land, animals, equipment, plants, etc.)

GET
/asset/animal
List animal assets
listAnimalAssets 5 params → 200401
POST
/asset/animal
Create an animal asset
createAnimalAsset body → 201401422
GET
/asset/animal/{id}
Get an animal asset
getAnimalAsset 1 param → 200401404
PATCH
/asset/animal/{id}
Update an animal asset
updateAnimalAsset 1 param body → 200401404
DELETE
/asset/animal/{id}
Delete an animal asset
deleteAnimalAsset 1 param → 204401404
GET
/asset/land
List land assets
listLandAssets 5 params → 200401
POST
/asset/land
Create a land asset
createLandAsset body → 201401422
GET
/asset/land/{id}
Get a land asset
getLandAsset 1 param → 200401404
PATCH
/asset/land/{id}
Update a land asset
updateLandAsset 1 param body → 200401404
DELETE
/asset/land/{id}
Delete a land asset
deleteLandAsset 1 param → 204401404
GET
/asset/plant
List plant assets
listPlantAssets 5 params → 200401
POST
/asset/plant
Create a plant asset
createPlantAsset body → 201401422
GET
/asset/plant/{id}
Get a plant asset
getPlantAsset 1 param → 200401404
PATCH
/asset/plant/{id}
Update a plant asset
updatePlantAsset 1 param body → 200401404
DELETE
/asset/plant/{id}
Delete a plant asset
deletePlantAsset 1 param → 204401404
GET
/asset/equipment
List equipment assets
listEquipmentAssets 5 params → 200401
POST
/asset/equipment
Create an equipment asset
createEquipmentAsset body → 201401422
GET
/asset/equipment/{id}
Get an equipment asset
getEquipmentAsset 1 param → 200401404
PATCH
/asset/equipment/{id}
Update an equipment asset
updateEquipmentAsset 1 param body → 200401404
DELETE
/asset/equipment/{id}
Delete an equipment asset
deleteEquipmentAsset 1 param → 204401404
GET
/asset/structure
List structure assets
listStructureAssets 5 params → 200401
POST
/asset/structure
Create a structure asset
createStructureAsset body → 201401422
GET
/asset/structure/{id}
Get a structure asset
getStructureAsset 1 param → 200401404
PATCH
/asset/structure/{id}
Update a structure asset
updateStructureAsset 1 param body → 200401404
DELETE
/asset/structure/{id}
Delete a structure asset
deleteStructureAsset 1 param → 204401404
GET
/asset/sensor
List sensor assets
listSensorAssets 5 params → 200401
POST
/asset/sensor
Create a sensor asset
createSensorAsset body → 201401422
GET
/asset/sensor/{id}
Get a sensor asset
getSensorAsset 1 param → 200401404
PATCH
/asset/sensor/{id}
Update a sensor asset
updateSensorAsset 1 param body → 200401404
DELETE
/asset/sensor/{id}
Delete a sensor asset
deleteSensorAsset 1 param → 204401404
GET
/asset/group
List group assets
listGroupAssets 5 params → 200401
POST
/asset/group
Create a group asset
createGroupAsset body → 201401422
GET
/asset/group/{id}
Get a group asset
getGroupAsset 1 param → 200401404
PATCH
/asset/group/{id}
Update a group asset
updateGroupAsset 1 param body → 200401404
DELETE
/asset/group/{id}
Delete a group asset
deleteGroupAsset 1 param → 204401404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are AssetAttributes (16 properties), AssetData (5 properties), AssetRelationships (4 properties), AssetCollection (4 properties). Each schema is shown below with its type and property counts.

JsonApiRelationship
object
2 properties
AssetRelationships
object
Common relationships shared by all asset types
4 properties
AssetData
object
5 properties 2 required
AssetCollection
object
4 properties
JsonApiError
object
1 property
AssetAttributes
object
Common attributes shared by all asset types
16 properties
AssetRequest
object
1 property 1 required
JsonApiLinks
object
2 properties
JsonApiRelationshipData
object
2 properties
AssetResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

farmos-assets-api-openapi.yml Raw ↑

Other APIs farmOS publishes across the network.

farmOS Logs API
farmOS Plans API
farmOS Quantities API
farmOS Server Info API
farmOS Taxonomy API
Where this information came from

This is an independent, third-party profile of farmOS Assets 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.