(only supported verbs are shown for each endpoint)
Actions are dynamically loaded endpoints from plugins.
GET
/app/(string: application)/actions
¶Returns list of available actions.
Example request:
$ curl -XGET '/app/widgetmaker/actions'
Example response
{
"application": "widgetmaker",
"actions": [
"ExampleAction1",
"SpecialDeploymentAction",
"CleanupAction"
]
}
GET
/app/(string: application)/actions/(string: action name)
¶Returns information about a specific action, including required parameters.
Note
Parameter types are not enforced. They exist for documentation purposes only.
Example request:
$ curl -XGET '/app/widgetmaker/actions/CleanupAction'
Example response
{
"action": {
"post_parameters": {
"days": {
"type": "integer",
"description": "clean builds older than this many days"
},
"delete": {
"type": "boolean (string)",
"description": "delete builds (true or false)"
}
},
"name": "CleanupAction"
},
"application": "widgetmaker"
}
POST
/app/(string: application)/actions/(string: action name)
¶Parameters: |
|
---|
Execute a named action. All parameters must be supplied or an error response will be generated.
Example request:
$ curl -XPOST '/app/widgetmaker/actions/CleanupAction?delete=true&days=30'
Example response
{
"status": "ok",
"message": {
"action": "CleanupAction",
"status": "async/running",
"job_id": "85982318-af22-4d5a-a8ce-725601ac24f4"
}
}