Explore
@hestia-earth/api
0.24.77
OAS3
Hestia REST API documentation.
GPL-3.0-or-later
Servers
https://api.hestia.earth
Authorize
default
GET
/actors
/{id}
/cycles
Get related Cycles to an Actor
GET
/actors
/{id}
/impactassessments
Get related Impact Assessments to an Actor
GET
/actors
/me
Get my Actor node
GET
/actors
/{id}
/sites
Get related Sites to an Actor
GET
/actors
/{id}
/sources
Get related Sources to an Actor
GET
/aggregation-engine
/backups
Get list of aggregation backups (for each product)
GET
/aggregation-engine
/backups
/{id}
Get single aggregation backup by product `@id`.
GET
/cycles
/{id}
/cycles
Get related Cycles to a Cycle
GET
/cycles
/{id}
/impactassessments
Get related Impact Assessments to a Cycle
GET
/distribution
/files
Get the files required for distribution library.
GET
/download
/token
Get a token to connect to the Download API.
POST
/files
Upload a file for processing
GET
/files
Search for files
GET
/files
/dashboard
Return dashboard data.
PATCH
/files
/{fileId}
/todos
/{index}
Update a file TODO item by ID
GET
/files
/folder
Get a list of distinct folders.
DELETE
/files
/folder
Delete a folder
PUT
/files
/folder
Update a folder name
GET
/files
/{fileId}
Get a file by ID
DELETE
/files
/{fileId}
Delete a file
PUT
/files
/{fileId}
Update a file name
GET
/files
/{fileId}
/authorized
Get list of users that have been authorised access to the file.
POST
/files
/{fileId}
/share
Grant access of a file to other users.
POST
/files
/{fileId}
/unshare
Revoke my access to a file.
PATCH
/files
/{fileId}
/submit
Submit a file for Hestia validation
PATCH
/files
/{fileId}
/validate
Send a file for indexing. If the file is public, only Hestia team members can perform this action.
GET
/glossary
/lookups
Get the list of Glossary lookups.
GET
/impactassessments
/{id}
/cycles
Get related Cycles to an ImpactAssessment
GET
/models
Get list of models available in Hestia.
GET
/models
/requirements
Get model requirements.
GET
/models
/requirements
/{model}
/{key}
Get a single model requirements.
GET
/models
/term-ids
Get model return term IDs.
POST
/convert
/csv
Convert nodes to CSV
GET
/cycles
/{id}
/deep-relations
Get nodes deeply related to a Cycle
GET
/impactassessments
/{id}
/deep-relations
Get nodes deeply related to an Impact Assessment
GET
/download
Download a Node
POST
/nodes
/files
Get the Files connected to the Nodes.
GET
/actors
/{id}
Get an Actor by ID
PUT
/actors
/{id}
Update an Actor by ID
GET
/cycles
/{id}
Get a Cycle by ID
PUT
/cycles
/{id}
Update a Cycle by ID
GET
/impactassessments
/{id}
Get an ImpactAssessment by ID
PUT
/impactassessments
/{id}
Update an ImpactAssessment by ID
GET
/organisations
/{id}
Get an Organisation by ID
PUT
/organisations
/{id}
Update an Organisation by ID
GET
/sites
/{id}
Get a Site by ID
PUT
/sites
/{id}
Update a Site by ID
GET
/sources
/{id}
Get a Source by ID
PUT
/sources
/{id}
Update a Source by ID
GET
/terms
/{id}
Get a Term by ID
POST
/search
Search for nodes
POST
/nodes
/validate
Run a list of Nodes through Data Validation.
POST
/recalculate
/cycle
Recalculates a full Cycle
POST
/recalculate
Recalculates a Node
GET
/sites
/{id}
/cycles
Get related Cycles to a Site
GET
/sites
/{id}
/impactassessments
Get related Impact Assessments to a Site
GET
/sources
/{id}
/cycles
Get related Cycles to a Source
GET
/sources
/{id}
/impactassessments
Get related Impact Assessments to a Source
GET
/sources
/{id}
/sites
Get related Sites to a Source
GET
/sources
/{id}
/sources
Get related Sources to a Source
GET
/terms
/{id}
/actors
Get related Actors to a Term
GET
/terms
/backups
Get list of Term backups (for each termType)
GET
/terms
/backups
/{termType}
Get a single Term backup by `termType`
GET
/terms
/countries
Get the number of Cycles per country.
GET
/terms
/{id}
/cycles
Get related Cycles to a Term
GET
/terms
/{id}
/impactassessments
Get related Impact Assessments to a Term
GET
/terms
/{id}
/organisations
Get related Organisations to a Term
GET
/terms
/{id}
/sites
Get related Sites to a Term
DELETE
/users
/me
Delete my account
GET
/users
/me
Get user data
PUT
/users
/me
Update my personal information
GET
/users
/me
/nodes
Search for nodes uploaded on my account.
GET
/users
/me
/nodes-count
Get count of nodes uploaded on my account.
POST
/users
/password
/reset
Send a reset password request
POST
/users
/signin
Sign into an existing account
PATCH
/users
/token
/reset
Reset my API token.
PUT
/users
/password
Update my password
Schemas
Error
AjvError
Document
File
NodeType
SchemaType
Actor
Cycle
ImpactAssessment
Organisation
Source
Site
Term
Node
User
NewUser
UpdateUser
