Hog
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all hog functions
Required API key scopes
hog_function:readPath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Query parameters
- created_atstring
- created_byinteger
- enabledboolean
- exclude_kindarrayMultiple values may be separated by commas. 
- idstring
- kindarrayMultiple values may be separated by commas. 
- limitintegerNumber of results to return per page. 
- offsetintegerThe initial index from which to return the results. 
- typearrayMultiple values may be separated by commas. 
- updated_atstring
Response
Request
GET 
Response
Status 200
Create hog functions
Required API key scopes
hog_function:writePath parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- type
- kindstring
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
Response
Request
POST 
Response
Status 201
Retrieve hog functions
Required API key scopes
hog_function:readPath parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Response
Request
GET 
Response
Status 200
Update hog functions
Required API key scopes
hog_function:writePath parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- type
- kindstring
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
Response
Request
PATCH 
Response
Status 200
Delete hog functions
Hard delete of this model is not allowed. Use a patch API call to set "deleted" to true
Required API key scopes
hog_function:writePath parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
DELETE 
Response
Status 405 No response body
Create hog functions broadcast
Path parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- type
- kindstring
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
Request
POST 
Response
Status 200 No response body
Create hog functions invocations
Path parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- type
- kindstring
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
Request
POST 
Response
Status 200 No response body
Retrieve hog functions logs
Path parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve hog functions metrics
Path parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve hog functions metrics totals
Path parameters
- idstringA UUID string identifying this hog function. 
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve hog functions icon
Path parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Retrieve hog functions icons
Path parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request
GET 
Response
Status 200 No response body
Update hog functions rearrange
Update the execution order of multiple HogFunctions.
Path parameters
- project_idstringProject ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/. 
Request parameters
- type
- kindstring
- namestring
- descriptionstring
- enabledboolean
- deletedboolean
- hogstring
- inputs_schemaarray
- inputsobject
- filters
- masking
- mappingsarray
- icon_urlstring
- template_idstring
- execution_orderinteger
Request
PATCH