Blackfire
Blackfire Python
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to BLACKFIRE_PYTHON . |
execute_commands Required | String[] | The commands that will be executed. |
version Required | String | The version of Python. |
integration_hash Required | String | The ID of the integration. |
shell | String | The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH . |
setup_commands | String[] | The command that will be executed only on the first run. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
"name": "Run Blackfire Python CLI",
"type": "BLACKFIRE_PYTHON",
"trigger_time": "ON_EVERY_EXECUTION",
"version": "latest",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"execute_commands": [
"pip install -r requirements.txt",
"blackfire run bin/console"
],
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"shell": "BASH"
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": "Run Blackfire Python CLI",
"type": "BLACKFIRE_PYTHON",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"pip install -r requirements.txt",
"blackfire run bin/console"
],
"shell": "SH",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"version": "latest",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Blackfire PHP
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to BLACKFIRE_PHP . |
execute_commands Required | String[] | The commands that will be executed. |
version Required | String | The version of PHP. |
integration_hash Required | String | The ID of the integration. |
shell | String | The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH . |
setup_commands | String[] | The command that will be executed only on the first run. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
"name": "Run Blackfire PHP CLI",
"type": "BLACKFIRE_PHP",
"trigger_time": "ON_EVERY_EXECUTION",
"version": "latest",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"execute_commands": [
"composer install",
"blackfire run bin/console"
],
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"shell": "BASH"
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": "Run Blackfire PHP CLI",
"type": "BLACKFIRE_PHP",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"composer install",
"blackfire run bin/console"
],
"shell": "SH",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"version": "latest",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}
Blackfire GO
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to BLACKFIRE_GO . |
execute_commands Required | String[] | The commands that will be executed. |
version Required | String | The version of GO. |
integration_hash Required | String | The ID of the integration. |
shell | String | The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH . |
setup_commands | String[] | The command that will be executed only on the first run. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{
"name": "Run Blackfire Go CLI",
"type": "BLACKFIRE_GO",
"trigger_time": "ON_EVERY_EXECUTION",
"version": "latest",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"execute_commands": [
"blackfire run ./go_bin"
],
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"shell": "BASH"
}
Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999
JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/2/edit",
"id": 2,
"name": "Run Blackfire Go CLI",
"type": "BLACKFIRE_GO",
"trigger_time": "ON_EVERY_EXECUTION",
"last_execution_status": "INITIAL",
"setup_commands": [
"apt-get update && apt-get -y install git"
],
"execute_commands": [
"blackfire run ./go_bin"
],
"shell": "SH",
"integration": {
"hash_id": "5ddb7c180fb38be67bd78a88a"
},
"version": "latest",
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "Live mirror",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
Last modified on December 5, 2022