Firebase

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to FIREBASE.

application_idrequired string

The ID of the Firebase application.

integrationrequired Integration

The integration.

execute_commandsrequired string[]

Commands that will be executed.

working_directoryoptional string

The directory in which the commands are executed. Available when type is set to CUSTOM.

volume_mappingsoptional string[]

The path preceding the colon is the filesystem path (the folder from the filesystem to be mounted in the container). The path after the colon is the container path (the path in the container, where this filesystem will be located).

shelloptional string

The name of the shell that will be used to execute commands. Can be one of SH (default) or BASH.

setup_commandsoptional string[]

The command that will be executed only on the first run.

Last modified on Oct 7, 2024

Eslint FTP

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Firebase deploy",
  "type": "FIREBASE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "volume_mappings": "/:/buddy/mount/directory",
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "firebase deploy --non-interactive"
  ],
  "application_id": "fir-test-25007",
  "shell": "SH",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/action/1/edit",
  "id": 1,
  "name": "Firebase deploy",
  "type": "FIREBASE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "volume_mappings": "/:/buddy/mount/directory",
  "last_execution_status": "INITIAL",
  "setup_commands": [
    "apt-get update && apt-get -y install git"
  ],
  "execute_commands": [
    "firebase deploy --non-interactive"
  ],
  "application_id": "fir-test-25007",
  "shell": "SH",
  "integration": {
    "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1",
    "html_url": "https://app.buddy.works/integrations",
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  },
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1",
    "id": 1,
    "name": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999