Hog functions
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
List all hog functions
Required API key scopes
hog_function:read
Path parameters
- project_idstring
Project 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
- idstring
- limitinteger
Number of results to return per page.
- offsetinteger
The initial index from which to return the results.
- searchstring
A search term.
- typearray
Multiple values may be separated by commas.
- updated_atstring
Response
Status 200
Create hog functions
Required API key scopes
hog_function:write
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 201
Retrieve hog functions
Required API key scopes
hog_function:read
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200
Update hog functions
Required API key scopes
hog_function:write
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
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:write
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 405 No response body
Create hog functions broadcast
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Create hog functions invocations
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve hog functions logs
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve hog functions metrics
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve hog functions metrics totals
Path parameters
- idstring
A UUID string identifying this hog function.
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve hog functions icon
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Retrieve hog functions icons
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.
Response
Status 200 No response body
Update hog functions rearrange
Update the execution order of multiple HogFunctions.
Path parameters
- project_idstring
Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.